#  LiteDB
LiteDB is NoSQL database.
LiteDB could be used as simple DB for simple projects.
This DB creates file with file extension **.json** (JavaScript Object Notification).
## Documentation
All information is stored in collections which contain objects.
All methods are allowed with common import:
```python
import NoSQLite3
```
but you can only import the required methods individually.
### CREATE
To create new DataBase you need call *.create_db* method:
```python
from NoSQLite3 import create_db
```
and pass to method db name. If database with this name has already existed, the Error will raise to console.
Example (DB does not exist)::
>>> from LiteDB import create_db
>>> create_db(db_name='name')
Example (DB exists)::
>>> from LiteDB import create_db
>>> create_db(db_name='name')
raise CreationError(f'DATABASE with name: {db_name} has already existed')
LiteDB._exceptions.CreationError: DATABASE with name: name has already existed
You can also use optional parameter "if_exists" to bypass the display of the exception, but a new database with an
already existing name will not be created.
#### ADDITION INFO
```python
def create_db(db_name: str, if_exists: bool = False) -> None:
"""
The function creates a database in the base directory of the project
:param if_exists: an optional parameter responsible for skipping an exception when creating a database with an
already existing name
:param db_name: the name of the database to be created. The name of the database must be unique in the project,
otherwise the file will be overwritten. Data is passed to the function as a string
:return: None
"""
pass
```
To create collection you need call *.create_collection* method:
```python
from NoSQLite3 import create_collection
```
and pass to method db name, collection name and list of collections. If collection with this name has already existed,
the Error will raise to console but program will continue working.
Example (Collection does not exist)::
>>> from LiteDB import create_collection
>>> create_collection(db_name='name', collection='col', objects=['o1', 'o2'])
Example (Collection exists)::
>>> from LiteDB import create_collection
>>> create_collection(db_name='name', collection='col', objects=['o1', 'o2'])
raise CreationError(f'Collection with name: {collection} has already existed')
LiteDB._exceptions.CreationError: Collection with name: col has already existed
#### ADDITION INFO
```python
def create_collectiob(db_name: str, collection: str, objects: list) -> None:
"""
The function creates a collection with collections
:param db_name: the selected database to create the collection. Data is passed to the function as a string
:param collection: collection name. IMPORTANT! The collection name must be unique. Data is passed to the function as a string
:param objects: objects names. A collection is similar to a column in a classic relational database, but at
the same time it does not require a clear fixation of data relative to other such collections. Data is
passed to the function as a list
:return: None
"""
pass
```
### INSERT
To insert one new value to DataBase you need call *.insert_one* method:
```python
from NoSQLite3 import insert_one
```
and pass to method db name, collection name, object and value.
Example::
>>> from LiteDB import insert_one
>>> insert_one(db_name='name', collection='col', object='o1', value='val')
#### ADDITION INFO
```python
def insert_one(db_name: str, collection: str, object: str, value) -> None:
"""
The function adds one value to the collection, the value is entered into a separate list, which has its own serial
number, calculated relative to the last serial number of the value.
:param object: The name of the object to add the value to
:param collection: The name of the collection to add the value to
:param db_name: The name of the database to add the value to
:param value: The value to be entered into the database
:return: None
"""
pass
```
To insert many new values to DataBase you need call *.insert_many* method:
```python
from NoSQLite3 import insert_many
```
and pass to method db name, collection name, object and values.
Example::
>>> from LiteDB import insert_many
>>> insert_many(db_name='name', collection='col', object='o1', values=['val1', 'val2'])
#### ADDITION INFO
```python
def insert_many(db_name: str, collection: str, object: str, values: list) -> None:
"""
The function adds many values to the collection, the value is entered into a separate list, which has its own serial
number, calculated relative to the last serial number of the value.
:param db_name: The name of the database to add values to
:param collection: The name of the collection to add values to
:param object: The name of the object to add values to
:param values: The values to be entered into the database
:return: None
"""
pass
```
### UPDATE
To update a single value by its ID, you need to import the *.update_value_by_id* method:
```python
from NoSQLite3 import update_value_by_id
```
In this method, you must pass the name of the database, the name of the collection, the name of the object and the
identifier of the value to be replaced, as well as the new value.
Example::
>>> from LiteDB import update_value_by_id
>>> update_value_by_id(db_name='name', collection='col', object='o1', id=1, value='val2')
#### ADDITION INFO
```python
def update_value_by_id(db_name: str, collection: str, object: str, id: int, value) -> None:
"""
The function updates the single value by the given identifier
:param db_name: the name of the database to be modified
:param collection: the name of the collection to be modified
:param object: the name of the object to be modified
:param id: identifier of the value to be modified
:param value: new value
:return: None
"""
pass
```
To update a few values by their ID, you need to import the *.update_values_by_id* method:
```python
from NoSQLite3 import update_values_by_id
```
In this method, you must pass the name of the database, the name of the collection, the name of the collection and the identifiers of the values (list) to be replaced, as well as the new
values (list).
Example::
>>> from LiteDB import update_values_by_id
>>> update_values_by_id(db_name='name', collection='col', object='o1', id=[1, 2], values=['val1', 'val2'])
#### ADDITION INFO
```python
def update_values_by_id(db_name: str, collection: str, object: str, id: list, values: list) -> None:
"""
The function updates the many values by the given identifiers
:param db_name: the name of the database to be modified
:param collection: the name of the collection to be modified
:param object: the name of the object to be modified
:param id: list of identifiers of the values to be modified
:param values: list of the new values
:return: None
"""
pass
```
### ALTER
To change an object in the database, you need to call the *.alter_object* method:
```python
from NoSQLite3 import alter_object
```
and pass the method name of db, collection name and old and new object name.
Example::
>>> from LiteDB import alter_object
>>> alter_object(db_name='name', collection='col', object_old='o1', object_new='o3')
#### ADDITION INFO
```python
def alter_object(db_name: str, collection: str, object_old: str, object_new: str) -> None:
"""
The function makes changes to the name of the object
:param db_name: the name of the database to be modified
:param collection: the name of the collection to be modified
:param object_old: the old name of the object to be modified
:param object_new: the new name of the object to be modified
:return: None
"""
pass
```
To change a collection in the database, you need to call the *.alter_collection* method:
```python
from NoSQLite3 import alter_collection
```
and pass the method name of db and old and new collection name.
Example::
>>> from LiteDB import alter_collection
>>> alter_object(db_name='name', collection_old='col1', collection_new='col3')
#### ADDITION INFO
```python
def alter_collection(db_name: str, collection_new: str, collection_old: str) -> None:
"""
The function makes changes to the name of the collection
:param db_name: the name of the database to be modified
:param collection_new: the new name of the collection to be modified
:param collection_old: the old name of the collection to be modified
:return: None
"""
pass
```
To change a name of the database, you need to call the *.alter_db* method:
```python
from NoSQLite3 import alter_db
```
and pass the method old and new names of db.
Example::
>>> from LiteDB import alter_db
>>> alter_object(db_name_old='name1', db_name_new='name2')
#### ADDITION INFO
```python
def alter_db(db_name_old: str, db_name_new: str) -> None:
"""
The function makes changes to the name of the database
:param db_name_old: the old name of the database to be modified
:param db_name_new: the new name of the database to be modified
:return: None
"""
pass
```
### DROP/DELETE
To drop database, you need to import the *.drop_db* method:
```python
from NoSQLite3 import drop_db
```
In this method, you must pass the name of the database.
Example::
>>> from LiteDB import drop_db
>>> drop_db(db_name='name')
#### ADDITION INFO
```python
def drop_db(db_name: str) -> None:
"""
The function deletes the database. IMPORTANT! Using this feature will result in data loss
:param db_name: the name of the database to be dropped
:return: None
"""
pass
```
To drop collection from database, you need to import the *.drop_db* method:
```python
from NoSQLite3 import drop_collection
```
In this method, you must pass the name of the database and the name of the collection.
Example::
>>> from LiteDB import drop_collection
>>> drop_collection(db_name='name', collection='col')
#### ADDITION INFO
```python
def drop_collection(db_name: str, collection: str) -> None:
"""
The function deletes the collection from database. IMPORTANT! Using this feature will result in data loss
:param db_name: the name of the database to be modified
:param collection: the name of the collection to be dropped
:return: None
"""
pass
```
To drop object from database, you need to import the *.drop_collection* method from the **drop** module.
```python
from NoSQLite3.drop import drop_object
```
In this method, you must pass the name of the database, the name of the collection and the name of the object.
Example::
>>> from LiteDB import drop_object
>>> drop_object(db_name='name', collection='col', object='o1')
#### ADDITION INFO
```python
def drop_collection(db_name: str, collection: str, object: str) -> None:
"""
The function deletes the collection from database. IMPORTANT! Using this feature will result in data loss
:param db_name: the name of the database to be modified
:param collection: the name of the collection to be modified
:param object: the name of the object to be dropped
:return: None
"""
pass
```
[//]: # (## Installation)
[//]: # ()
[//]: # (Install my-project with pip)
[//]: # ()
[//]: # (```bash)
[//]: # ( pip install litedb)
[//]: # (```)
## Authors
- [@macht1212](https://www.github.com/macht1212) Alexander Nazimov
## License
[MIT](https://github.com/macht1212/LiteDB/blob/0711686a88e82182ed37199da73cea1b7595a75d/LICENSE.txt)
## Lessons Learned
Raw data
{
"_id": null,
"home_page": "https://github.com/macht1212/LiteDB/",
"name": "NoSQLite3",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "database,nosql,litedb",
"author": "Alexander Nazimov (GitHub @macht1212)",
"author_email": "nasimov.alexander@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/96/ee/324b46de76c0811106455169314dff1f45049f0e01b271a2d268ac51ba50/NoSQLite3-0.1.1.tar.gz",
"platform": null,
"description": "\n#  LiteDB\n\n\n\nLiteDB is NoSQL database.\nLiteDB could be used as simple DB for simple projects.\nThis DB creates file with file extension **.json** (JavaScript Object Notification).\n\n## Documentation\n\nAll information is stored in collections which contain objects. \nAll methods are allowed with common import:\n\n```python\nimport NoSQLite3\n```\nbut you can only import the required methods individually. \n\n\n### CREATE\nTo create new DataBase you need call *.create_db* method:\n\n```python\nfrom NoSQLite3 import create_db\n```\nand pass to method db name. If database with this name has already existed, the Error will raise to console.\n\nExample (DB does not exist)::\n\n >>> from LiteDB import create_db\n >>> create_db(db_name='name')\n\nExample (DB exists)::\n\n >>> from LiteDB import create_db\n >>> create_db(db_name='name')\n raise CreationError(f'DATABASE with name: {db_name} has already existed')\n LiteDB._exceptions.CreationError: DATABASE with name: name has already existed\n\nYou can also use optional parameter \"if_exists\" to bypass the display of the exception, but a new database with an \nalready existing name will not be created.\n\n#### ADDITION INFO\n```python\ndef create_db(db_name: str, if_exists: bool = False) -> None:\n \"\"\"\n The function creates a database in the base directory of the project\n :param if_exists: an optional parameter responsible for skipping an exception when creating a database with an\n already existing name\n :param db_name: the name of the database to be created. The name of the database must be unique in the project,\n otherwise the file will be overwritten. Data is passed to the function as a string\n :return: None\n \"\"\"\n pass\n```\n\nTo create collection you need call *.create_collection* method:\n\n```python\nfrom NoSQLite3 import create_collection\n```\nand pass to method db name, collection name and list of collections. If collection with this name has already existed,\nthe Error will raise to console but program will continue working.\n\nExample (Collection does not exist):: \n\n >>> from LiteDB import create_collection\n >>> create_collection(db_name='name', collection='col', objects=['o1', 'o2'])\n\nExample (Collection exists)::\n\n >>> from LiteDB import create_collection\n >>> create_collection(db_name='name', collection='col', objects=['o1', 'o2'])\n raise CreationError(f'Collection with name: {collection} has already existed')\n LiteDB._exceptions.CreationError: Collection with name: col has already existed\n\n#### ADDITION INFO\n```python\ndef create_collectiob(db_name: str, collection: str, objects: list) -> None:\n \"\"\"\n The function creates a collection with collections\n :param db_name: the selected database to create the collection. Data is passed to the function as a string\n :param collection: collection name. IMPORTANT! The collection name must be unique. Data is passed to the function as a string\n :param objects: objects names. A collection is similar to a column in a classic relational database, but at\n the same time it does not require a clear fixation of data relative to other such collections. Data is\n passed to the function as a list\n :return: None\n \"\"\"\n pass\n```\n\n### INSERT\n\nTo insert one new value to DataBase you need call *.insert_one* method:\n\n```python\nfrom NoSQLite3 import insert_one\n```\nand pass to method db name, collection name, object and value.\n\nExample::\n\n >>> from LiteDB import insert_one\n >>> insert_one(db_name='name', collection='col', object='o1', value='val')\n\n#### ADDITION INFO\n```python\ndef insert_one(db_name: str, collection: str, object: str, value) -> None:\n \"\"\"\n The function adds one value to the collection, the value is entered into a separate list, which has its own serial\n number, calculated relative to the last serial number of the value.\n :param object: The name of the object to add the value to\n :param collection: The name of the collection to add the value to\n :param db_name: The name of the database to add the value to\n :param value: The value to be entered into the database\n :return: None\n \"\"\"\n pass\n```\n\n\nTo insert many new values to DataBase you need call *.insert_many* method:\n\n```python\nfrom NoSQLite3 import insert_many\n```\nand pass to method db name, collection name, object and values.\n\nExample::\n\n >>> from LiteDB import insert_many\n >>> insert_many(db_name='name', collection='col', object='o1', values=['val1', 'val2'])\n\n\n#### ADDITION INFO\n```python\ndef insert_many(db_name: str, collection: str, object: str, values: list) -> None:\n \"\"\"\n The function adds many values to the collection, the value is entered into a separate list, which has its own serial\n number, calculated relative to the last serial number of the value.\n :param db_name: The name of the database to add values to\n :param collection: The name of the collection to add values to\n :param object: The name of the object to add values to\n :param values: The values to be entered into the database\n :return: None\n \"\"\"\n pass\n```\n\n\n### UPDATE\nTo update a single value by its ID, you need to import the *.update_value_by_id* method:\n\n```python\nfrom NoSQLite3 import update_value_by_id\n```\n\nIn this method, you must pass the name of the database, the name of the collection, the name of the object and the \nidentifier of the value to be replaced, as well as the new value.\n\nExample::\n\n >>> from LiteDB import update_value_by_id\n >>> update_value_by_id(db_name='name', collection='col', object='o1', id=1, value='val2')\n\n\n#### ADDITION INFO\n```python\ndef update_value_by_id(db_name: str, collection: str, object: str, id: int, value) -> None:\n \"\"\"\n The function updates the single value by the given identifier\n :param db_name: the name of the database to be modified\n :param collection: the name of the collection to be modified\n :param object: the name of the object to be modified\n :param id: identifier of the value to be modified\n :param value: new value\n :return: None\n \"\"\"\n pass\n``` \nTo update a few values by their ID, you need to import the *.update_values_by_id* method:\n\n```python\nfrom NoSQLite3 import update_values_by_id\n```\n\nIn this method, you must pass the name of the database, the name of the collection, the name of the collection and the identifiers of the values (list) to be replaced, as well as the new \nvalues (list).\n\nExample::\n \n >>> from LiteDB import update_values_by_id\n >>> update_values_by_id(db_name='name', collection='col', object='o1', id=[1, 2], values=['val1', 'val2'])\n\n \n#### ADDITION INFO\n```python\ndef update_values_by_id(db_name: str, collection: str, object: str, id: list, values: list) -> None:\n \"\"\"\n The function updates the many values by the given identifiers\n :param db_name: the name of the database to be modified\n :param collection: the name of the collection to be modified\n :param object: the name of the object to be modified\n :param id: list of identifiers of the values to be modified\n :param values: list of the new values\n :return: None\n \"\"\"\n pass\n```\n\n### ALTER\n\nTo change an object in the database, you need to call the *.alter_object* method:\n\n```python\nfrom NoSQLite3 import alter_object\n```\nand pass the method name of db, collection name and old and new object name. \n\nExample::\n\n >>> from LiteDB import alter_object\n >>> alter_object(db_name='name', collection='col', object_old='o1', object_new='o3')\n\n\n#### ADDITION INFO\n```python\ndef alter_object(db_name: str, collection: str, object_old: str, object_new: str) -> None:\n \"\"\"\n The function makes changes to the name of the object\n :param db_name: the name of the database to be modified\n :param collection: the name of the collection to be modified\n :param object_old: the old name of the object to be modified\n :param object_new: the new name of the object to be modified\n :return: None\n \"\"\"\n pass\n```\n\nTo change a collection in the database, you need to call the *.alter_collection* method:\n\n```python\nfrom NoSQLite3 import alter_collection\n```\nand pass the method name of db and old and new collection name. \n\nExample::\n\n >>> from LiteDB import alter_collection\n >>> alter_object(db_name='name', collection_old='col1', collection_new='col3')\n\n\n#### ADDITION INFO\n```python\ndef alter_collection(db_name: str, collection_new: str, collection_old: str) -> None:\n \"\"\"\n The function makes changes to the name of the collection\n :param db_name: the name of the database to be modified\n :param collection_new: the new name of the collection to be modified\n :param collection_old: the old name of the collection to be modified\n :return: None\n \"\"\"\n pass\n```\n\nTo change a name of the database, you need to call the *.alter_db* method:\n\n```python\nfrom NoSQLite3 import alter_db\n```\nand pass the method old and new names of db. \n\nExample::\n \n >>> from LiteDB import alter_db\n >>> alter_object(db_name_old='name1', db_name_new='name2')\n\n\n#### ADDITION INFO\n```python\ndef alter_db(db_name_old: str, db_name_new: str) -> None:\n \"\"\"\n The function makes changes to the name of the database\n :param db_name_old: the old name of the database to be modified\n :param db_name_new: the new name of the database to be modified\n :return: None\n \"\"\"\n pass\n```\n\n### DROP/DELETE\n\nTo drop database, you need to import the *.drop_db* method:\n\n```python\nfrom NoSQLite3 import drop_db\n```\n\nIn this method, you must pass the name of the database.\n\nExample::\n\n >>> from LiteDB import drop_db\n >>> drop_db(db_name='name')\n\n\n#### ADDITION INFO\n```python\ndef drop_db(db_name: str) -> None:\n \"\"\"\n The function deletes the database. IMPORTANT! Using this feature will result in data loss\n :param db_name: the name of the database to be dropped\n :return: None\n \"\"\"\n pass\n```\n\n\nTo drop collection from database, you need to import the *.drop_db* method:\n\n```python\nfrom NoSQLite3 import drop_collection\n```\n\nIn this method, you must pass the name of the database and the name of the collection.\n\nExample::\n \n >>> from LiteDB import drop_collection\n >>> drop_collection(db_name='name', collection='col')\n\n\n#### ADDITION INFO\n```python\ndef drop_collection(db_name: str, collection: str) -> None:\n \"\"\"\n The function deletes the collection from database. IMPORTANT! Using this feature will result in data loss\n :param db_name: the name of the database to be modified\n :param collection: the name of the collection to be dropped\n :return: None\n \"\"\"\n pass\n```\n\n\nTo drop object from database, you need to import the *.drop_collection* method from the **drop** module.\n\n```python\nfrom NoSQLite3.drop import drop_object\n```\n\nIn this method, you must pass the name of the database, the name of the collection and the name of the object.\n\nExample::\n\n >>> from LiteDB import drop_object\n >>> drop_object(db_name='name', collection='col', object='o1')\n\n\n#### ADDITION INFO\n```python\ndef drop_collection(db_name: str, collection: str, object: str) -> None:\n \"\"\"\n The function deletes the collection from database. IMPORTANT! Using this feature will result in data loss\n :param db_name: the name of the database to be modified\n :param collection: the name of the collection to be modified\n :param object: the name of the object to be dropped\n :return: None\n \"\"\"\n pass\n```\n\n\n[//]: # (## Installation)\n\n[//]: # ()\n[//]: # (Install my-project with pip)\n\n[//]: # ()\n[//]: # (```bash)\n\n[//]: # ( pip install litedb)\n\n[//]: # (```)\n \n## Authors\n\n- [@macht1212](https://www.github.com/macht1212) Alexander Nazimov\n\n\n## License\n\n[MIT](https://github.com/macht1212/LiteDB/blob/0711686a88e82182ed37199da73cea1b7595a75d/LICENSE.txt)\n\n\n## Lessons Learned\n\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "NoSQL database",
"version": "0.1.1",
"project_urls": {
"Download": "https://github.com/macht1212/LiteDB/archive/0.1.1.tar.gz",
"Homepage": "https://github.com/macht1212/LiteDB/"
},
"split_keywords": [
"database",
"nosql",
"litedb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "96ee324b46de76c0811106455169314dff1f45049f0e01b271a2d268ac51ba50",
"md5": "e776cab54f57a66677fcc9083919b97e",
"sha256": "c48dbfc561d26df14b7396a1af0bc6466f9ca542e8b961e1d8b248102f3fe5f1"
},
"downloads": -1,
"filename": "NoSQLite3-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e776cab54f57a66677fcc9083919b97e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8700,
"upload_time": "2023-07-19T21:54:54",
"upload_time_iso_8601": "2023-07-19T21:54:54.228817Z",
"url": "https://files.pythonhosted.org/packages/96/ee/324b46de76c0811106455169314dff1f45049f0e01b271a2d268ac51ba50/NoSQLite3-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-19 21:54:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "macht1212",
"github_project": "LiteDB",
"github_not_found": true,
"lcname": "nosqlite3"
}
JSON
