https://github.com/agentejo/mongo-lite

Schemaless database on top of SQLite
https://github.com/agentejo/mongo-lite

Last synced: about 2 months ago
JSON representation

Schemaless database on top of SQLite

• Host: GitHub
• URL: https://github.com/agentejo/mongo-lite
• Owner: agentejo
• Created: 2013-04-05T00:43:56.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2020-07-13T16:34:04.000Z (about 4 years ago)
• Last Synced: 2024-05-01T20:34:42.755Z (5 months ago)
• Language: PHP
• Homepage:
• Size: 45.9 KB
• Stars: 160
• Watchers: 9
• Forks: 19
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
MongoLite

=========

Schemaless database on top of SqLite

### Sample Usage

``` php

$client     = new MongoLite\Client(PATH_TO_WRITABLE_FOLDER);

$database   = $client->testdb;

$collection = $database->products;

$entry = ["name"=>"Super cool Product", "price"=>20];

$collection->insert($entry);

$products = $collection->find(); // Get Cursor

if ($products->count()) {

    foreach($products->sort(["price"=>1])->limit(5) as $product) {

        var_dump($product);

    }

}

```

### Query collection

In general you can use a callback or simple array as criteria

``` php

$collection->find(function($document) {   // recommended to query data

    return $document["price"] > 10;

});

//or

$collection->find(["price"=>['$gt'=>10]]); // only very simple criteria is supported (can be slow)

//or just one

$collection->findOne(function($document) { ... });

$collection->findOne([...]);

```

### Writing documents

``` php

$collection->insert($document);

$collection->save($document);

$collection->update($criteria, $data);

```

### Delete documents

``` php

$collection->remove($criteria);

```

##API

**Client**

``` php

Client::listDBs()

Client::selectDB(databasename)

Client::selectCollection(databasename, collectionname)

```

**Database**

``` php

Database::vacuum()

Database::drop()

Database::createCollection(collectionname)

Database::dropCollection(collectionname)

Database::getCollectionNames()

Database::listCollections()

Database::selectCollection(collectionname)

```

**Collection**

``` php

Collection::drop()

Collection::renameCollection(newname)

Collection::insert(document)

Collection::save(document)

Collection::update(criteria, data)

Collection::remove(criteria)

Collection::count()

Collection::find(criteria)

Collection::findOne(criteria)

```

**Cursor**

``` php

Cursor::count()

Cursor::limit(number)

Cursor::skip(number)

Cursor::sort(array)

Cursor::each($callable)

Cursor::toArray()

```

## Installation

To install and use MongoLite via the composer PHP package manager just take these steps:

If you don’t already have one, create the file composer.json in the root of your new project that is going to use MongoLite.

Add the following to the composer.json file..

    {

        "require": {

            "agentejo/mongo-lite": "dev-master"

        }

    }

Install composer (if it isn’t already installed):

    curl -s https://getcomposer.org/installer | php

    php composer.phar install