MontyDB

https://pypi.org/project/montydb/
Admin
A pure Python-implemented database that looks and works like MongoDB with support for multiple...
Tokens:4,559
Snippets:79
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install MontyDB

Source: https://pypi.org/project/montydb

Standard installation command for the MontyDB package.

```bash
pip install montydb
```

--------------------------------

### Installing MontyDB Dependencies

Source: https://pypi.org/project/montydb

Installs all project dependencies using Poetry, creating a virtual environment.

```bash
make install

```

--------------------------------

### Example of Running MontyDB Tests

Source: https://pypi.org/project/montydb

Provides a concrete example of how to run MontyDB tests with specific configurations for storage, MongoDB instance, and BSON usage.

```bash
poetry run pytest --storage memory --mongodb localhost:30044 --use-bson

```

--------------------------------

### Install montydb with BSON support

Source: https://pypi.org/project/montydb/2.5.6

Installs montydb with optional BSON support, which requires installing pymongo.

```bash
pip install montydb[bson]

```

--------------------------------

### Install montydb

Source: https://pypi.org/project/montydb/2.5.6

Standard installation of the montydb package using pip.

```bash
pip install montydb

```

--------------------------------

### SQLite Configuration Example

Source: https://pypi.org/project/montydb

Configuration for SQLite storage, including journal mode and thread checking.

```ini
[sqlite]
journal_mode = WAL
check_same_thread =   # Leave it empty as False, or any value will be True

```

--------------------------------

### MontyDB Makefile Help

Source: https://pypi.org/project/montydb/2.5.6

Execute `make` or `make help` to display available commands for managing the MontyDB project, including installation, testing, linting, and building.

```bash
make or make help

```

--------------------------------

### Install MontyDB with BSON support

Source: https://pypi.org/project/montydb

Optional installation to include BSON support, which requires the pymongo package.

```bash
pip install montydb[bson]
```

--------------------------------

### Install MontyDB with LMDB storage

Source: https://pypi.org/project/montydb

Optional installation to enable the Lightning Memory-Mapped Database (LMDB) storage engine.

```bash
pip install montydb[lmdb]
```

--------------------------------

### LMDB Configuration Example

Source: https://pypi.org/project/montydb

Configuration for LMDB storage, specifying the maximum map size for the database.

```ini
[lightning]
map_size: 10485760  # Maximum size database may grow to.

```

--------------------------------

### Running MontyDB Makefile Commands

Source: https://pypi.org/project/montydb

Lists available commands in the Makefile for managing the project, including installation, updates, testing, linting, and building.

```bash
make or make help

install                        install all dependencies locally
update                         update project dependencies locally (run after git update)
ci                             Run all checks (codespell, lint, bandit, test)
test                           Run tests
lint                           Run linting with flake8
codespell                      Find typos with codespell
bandit                         Run static security analysis with bandit
build                          Build project using poetry
clean                          Clean project

```

--------------------------------

### Install montydb with LMDB storage

Source: https://pypi.org/project/montydb/2.5.6

Installs montydb with optional LMDB (Lightning Memory-Mapped Database) storage engine support.

```bash
pip install montydb[lmdb]

```

--------------------------------

### Running MongoDB Docker Image

Source: https://pypi.org/project/montydb

Starts a MongoDB Docker container for testing purposes, specifying the version and port mapping.

```bash
docker run --name monty-4.4 -p 30044:27017 -d mongo:4.4

```

--------------------------------

### Initialize Flat-File Client

Source: https://pypi.org/project/montydb

Initializes a MontyDB client using the default flat-file storage engine. Optionally sets storage configuration before client initialization.

```python
from montydb import set_storage, MontyClient


set_storage("/db/repo", cache_modified=5)  # optional step
client = MontyClient("/db/repo")  # use current working dir if no path given

# ready to go

```

--------------------------------

### Basic montydb Usage

Source: https://pypi.org/project/montydb/2.5.6

Demonstrates basic CRUD operations using MontyClient in-memory. Requires importing MontyClient.

```python
from montydb import MontyClient

col = MontyClient(":memory:").db.test
col.insert_many( [{"stock": "A", "qty": 6}, {"stock": "A", "qty": 2}] )
cur = col.find( {"stock": "A", "qty": {"$gt": 4}} )
next(cur)

```

--------------------------------

### Flat-File Storage Client

Source: https://pypi.org/project/montydb/2.5.6

Initializes a MontyClient using the default flat-file storage engine. An optional step to configure storage settings like cache_modified can be performed beforehand. If no path is given, the current working directory is used.

```python
from montydb import set_storage, MontyClient


set_storage("/db/repo", cache_modified=5)  # optional step
client = MontyClient("/db/repo")  # use current working dir if no path given

# ready to go


```

--------------------------------

### In-Memory Storage Client

Source: https://pypi.org/project/montydb/2.5.6

Initializes a MontyClient using the in-memory storage engine. No configuration is needed as data is not persisted to disk.

```python
from montydb import MontyClient


client = MontyClient(":memory:")

# ready to go


```

--------------------------------

### Initialize In-Memory Client

Source: https://pypi.org/project/montydb

Initializes a MontyDB client using the in-memory storage engine. No configuration is needed as data is not persisted to disk.

```python
from montydb import MontyClient


client = MontyClient(":memory:")

# ready to go

```

--------------------------------

### SQLite Storage Client

Source: https://pypi.org/project/montydb/2.5.6

Configures and initializes a MontyClient using the SQLite storage engine. The set_storage function is required to specify SQLite as the engine and the repository path. Note that pre-existing SQLite storage files from versions prior to 2.0.0 are not compatible.

```python
from montydb import set_storage, MontyClient


set_storage("/db/repo", storage="sqlite")  # required, to set sqlite as engine
client = MontyClient("/db/repo")


```

--------------------------------

### Basic MontyDB Operations

Source: https://pypi.org/project/montydb

Demonstrates inserting documents and querying with a greater than condition using MontyDB in-memory.

```python
>>> from montydb import MontyClient

>>> col = MontyClient(":memory:").db.test
>>> col.insert_many( [ {"stock": "A", "qty": 6}, {"stock": "A", "qty": 2} ] )
>>> cur = col.find( {"stock": "A", "qty": {"$gt": 4}} )
>>> next(cur)
{'_id': ObjectId('5ad34e537e8dd45d9c61a456'), 'stock': 'A', 'qty': 6}
```

--------------------------------

### Setting up MontyDB with SQLite Storage

Source: https://pypi.org/project/montydb

Configures MontyDB to use SQLite as the storage backend, specifying the repository path, storage type, BSON usage, and SQLite-specific pragmas and connection options.

```python
repo = "path_to/repo"
set_storage(
    repository=repo,
    storage="sqlite",
    use_bson=True,
    # sqlite pragma
    journal_mode="WAL",
    # sqlite connection option
    check_same_thread=False,
)
client = MontyClient(repo)
...
```

--------------------------------

### Setting up MontyDB with LMDB Storage

Source: https://pypi.org/project/montydb

Configures MontyDB to use LMDB (Lightning Memory-Mapped Database) as the storage engine. This requires explicitly setting the storage type before initializing the client.

```python
from montydb import set_storage, MontyClient


set_storage("/db/repo", storage="lightning")  # required, to set lightning as engine
client = MontyClient("/db/repo")

# ready to go

```

--------------------------------

### Connecting to MontyDB using a URI

Source: https://pypi.org/project/montydb

Connects to a MontyDB repository using a URI scheme, which can be a convenient way to specify the repository path.

```python
client = MontyClient("montydb:///db/repo")

```

--------------------------------

### Configure Flat-File Storage

Source: https://pypi.org/project/montydb

Configures MontyDB to use the flat-file storage engine with specified repository path and cache settings.

```python
from montydb import set_storage, MontyClient


set_storage(
    # general settings
    
    repository="/db/repo",  # dir path for database to live on disk, default is {cwd}
    storage="flatfile",     # storage name, default "flatfile"
    mongo_version="4.0",    # try matching behavior with this mongodb version
    use_bson=False,         # default None, and will import pymongo's bson if None or True

    # any other kwargs are storage engine settings.
    
    cache_modified=10,       # the only setting that flat-file have
)

# ready to go

```

--------------------------------

### SQLite Write Concern Configuration

Source: https://pypi.org/project/montydb

Sets up a MontyClient with specific write concern options for SQLite, including synchronous mode, automatic indexing, and busy timeout.

```python
client = MontyClient("/db/repo",
                     synchronous=1,
                     automatic_index=False,
                     busy_timeout=5000)

```

--------------------------------

### Running MontyDB Tests

Source: https://pypi.org/project/montydb

Executes MontyDB tests using pytest, allowing specification of the storage engine, MongoDB instance URL, and BSON usage.

```bash
poetry run pytest --storage {storage engin name} --mongodb {mongo instance url} [--use-bson]

```

--------------------------------

### Configure Flat-File Storage

Source: https://pypi.org/project/montydb/2.5.6

Configures the flat-file storage engine for montydb, specifying repository path, storage type, MongoDB version compatibility, and BSON usage. Other keyword arguments are specific to the storage engine.

```python
from montydb import set_storage, MontyClient


set_storage(
    # general settings
    
    repository="/db/repo",  # dir path for database to live on disk, default is {cwd}
    storage="flatfile",     # storage name, default "flatfile"
    mongo_version="4.0",    # try matching behavior with this mongodb version
    use_bson=False,         # default None, and will import pymongo's bson if None or True

    # any other kwargs are storage engine settings.
    
    cache_modified=10,       # the only setting that flat-file have
)

# ready to go


```

--------------------------------

### Using MontyList for CRUD Operations

Source: https://pypi.org/project/montydb

Demonstrates the usage of MontyList, an experimental subclass of list that combines list functionality with common CRUD methods found in MongoDB's Collection and Cursor.

```python
from montydb.utils import MontyList

mtl = MontyList([1, 2, {"a": 1}, {"a": 5}, {"a": 8}])
mtl.find({"a": {"$gt": 3}})
MontyList([{'a': 5}, {'a': 8}])

```

--------------------------------

### Restoring Data with montyrestore

Source: https://pypi.org/project/montydb

Loads a binary database dump (BSON file) into a MontyCollection. This is the counterpart to montydump and can also load files from mongodump.

```python
from montydb import open_repo, utils


with open_repo("foo/bar"):
    utils.montyrestore("db", "col", "/path/dump.bson")

```

--------------------------------

### Dumping Data with montydump

Source: https://pypi.org/project/montydb

Creates a binary export (BSON file) from a MontyCollection. This data can be restored using montyrestore or mongorestore.

```python
from montydb import open_repo, utils


with open_repo("foo/bar"):
    utils.montydump("db", "col", "/data/dump.bson")

```

--------------------------------

### Configure SQLite Storage

Source: https://pypi.org/project/montydb

Configures MontyDB to use the SQLite storage engine. This is a required step before initializing the client for SQLite.

```python
from montydb import set_storage, MontyClient


set_storage("/db/repo", storage="sqlite")  # required, to set sqlite as engine
client = MontyClient("/db/repo")

```

--------------------------------

### Importing Data with montyimport

Source: https://pypi.org/project/montydb

Imports data from an Extended JSON file into a specified MontyCollection. This utility is useful for loading data generated by montyexport or mongoexport.

```python
from montydb import open_repo, utils


with open_repo("foo/bar"):
    utils.montyimport("db", "col", "/path/dump.json")

```

--------------------------------

### Updating MontyDB Dependencies

Source: https://pypi.org/project/montydb

Updates project dependencies locally, typically run after git operations like updates or merges.

```bash
make update

```

--------------------------------

### Exporting Data with montyexport

Source: https://pypi.org/project/montydb

Exports data from a MontyCollection to a JSON file. The output can be used with montyimport or mongoimport.

```python
from montydb import open_repo, utils


with open_repo("foo/bar"):
    utils.montyexport("db", "col", "/data/dump.json")

```

--------------------------------

### Recording MongoDB Queries with MongoQueryRecorder

Source: https://pypi.org/project/montydb

Records find and distinct queries from a MongoDB database by accessing its profiler data. This is useful for debugging or reproducing queries.

```python
from pymongo import MongoClient
from montydb.utils import MongoQueryRecorder

client = MongoClient()
recorder = MongoQueryRecorder(client["mydb"])
recorder.start()

# Make some queries or run the App...
recorder.stop()
recorder.extract()
{<collection_1>: [<doc_1>, <doc_2>, ...], ...}

```
Tokens:
Raw