pyBaseDB 0.2.3

Python built NoSQL database

Index:

1. Classes

   1. Record

      • Methods
        1. addOrQuery
        2. addQuery
        3. delete
        4. get
        5. insert
        6. mark_delete
        7. query
        8. setLimit
        9. sort_by

   2. pyBase

      • Methods

        1. delete
        2. getCreationTime
        3. update
        4. updateTime

      • Static Methods

        1. getConfigPath
        2. getDBInfo
        3. getDatabases

2. Functions

   1. create_database_from_schema
   2. create_new_database
   3. encrypt
   4. load_data
   5. save

pyBase

Classes

class Record()

• Record(database=None)

Methods defined here:

• addOrQuery(self, field: str, operator, condition) -> object

• addQuery(self, field: str, operator, condition) -> object

  Filter data by field and by providing a value

• delete(self) -> None

  DEPRECATED METHOD

• get(self, id: str, p=False) -> pyBase

  Returns a single database entry

  1. @param id - Unique record ID

  2. @param p - Flag for formated print

  3. @returns pyBase Object

• insert(self, json_data: dict) -> str

  Inserts [Record](#Record) in Database

  1. @param json_data - dict

• mark_delete(self, data: dict) -> object

  DEPRECATED METHOD

• query(self, p=False) -> None

  Returns the results of a database with/without filter options and stores in "result" variable

  1. @param p - Flag for formated print

  2. @returns None

• setLimit(self, limit: int) -> None

  Set the number of Records returned

  1. @param limit - Number of records

• sort_by(self, field: str, order: str) -> object

  Set the order of the list

  1. @param field - Field of a Database

  2. @param order - If order is Ascending or Descending

---

class pyBase

• pyBase(record=None, database=None, index=None)

Methods defined here:

• delete(self) -> None

  Permanently deletes Record from database

• getCreationTime(self)

  Returns date of Record creation

• update(self) -> None

  Permanently saves Record changes in Database

• updateTime(self)

  Returns last update date

---

Static methods defined here:

• getConfigPath()

  Returns pyBase local path

• getDBInfo(db: str) -> None

  Get DB structure

• getDatabases() -> list

  Get databases in local system

---

Functions

• create_database_from_schema(verbose=False)

• create_new_database(name, verbose=True)

  Method to create new database

• encrypt(*args, **kwargs)

  Method to encrypt data

• load_data(db)

  Loads data from a DB

  1. @param db - Name of Database
  2. @returns JSON dict

• save(data, where)

  Save json data