https://github.com/robertgrubb/filerdb-php

Simple PHP flat file database.
https://github.com/robertgrubb/filerdb-php

composer composer-package database flatfile packagist php query

Last synced: 3 months ago
JSON representation

Simple PHP flat file database.

• Host: GitHub
• URL: https://github.com/robertgrubb/filerdb-php
• Owner: RobertGrubb
• License: mit
• Created: 2020-05-29T04:26:07.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-10T05:18:12.000Z (about 1 year ago)
• Last Synced: 2024-08-11T19:37:48.770Z (6 months ago)
• Topics: composer, composer-package, database, flatfile, packagist, php, query
• Language: PHP
• Size: 120 KB
• Stars: 7
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FilerDB

A simplistic PHP flat file database designed to get your application up and running fast. Please note this package is currently in development and is not yet at a release.

# Usage

Install via composer:

`composer require robert-grubb/filerdb-php`

*NOTE*: Please make sure your database directory has correct permissions for READ and WRITE.

### Instantiating

```

use FilerDB\Instance;

// Instantiate Database

$filerdb = new Instance([ 'root' => __DIR__ . '/database/' ]);

```

### Configuration

```

[

  /**

   * This is the root path for FilerDB.

   */

  'root' => false,

  /**

   * If the root path does not exist, try

   * and create it.

   */

  'createRootIfNotExist' => false,

  /**

   * If the database does not exist, try

   * and create it.

   */

  'createDatabaseIfNotExist' => false,

  /**

   * If the collection does not exist, attempt

   * to create it.

   */

  'createCollectionIfNotExist' => false,

  /**

   * If the insert and update logic handles

   * the createdAt and updatedAt timestamps

   * automatically

   */

  'includeTimestamps' => false

]

```

### Creating a database

```

$filerdb->databases->create('dev');

```

### Check if database exists

```

$filerdb->databases->exists('dev'); // Returns true or false

```

### List all databases

```

$filerdb->databases->list(); // Returns array

```

### Deleting a database

```

$filerdb->databases->delete('dev');

```

### Selecting a default database

Selecting a default database allows you to not have to specify the database on every call. Please refer to the below code on how to do that.

```

// Specify it in the configuration:

$filerdb = new Instance([

  'path' => __DIR__ . '/database/',

  'database' => 'database_name'

]);

```

or

```

$filerdb->selectDatabase('database_name');

```

With the above, you can now do the following:

```

$filerdb->collection('users')->all(); // Notice no ->database()

```

### List collections in a database

```

$filerdb->database('dev')->collections(); // Returns array

```

### Check if collection exists

```

$filerdb->database('dev')->collectionExists('dev'); // Returns true of false

```

### Creating a collection

```

$filerdb->database('dev')->createCollection('users');

```

### Deleting a collection

```

$filerdb->database('dev')->deleteCollection('users');

```

### Empty a collection

```

$filerdb->database('dev')->collection('users')->empty();

```

### Inserting a document

```

$filerdb->database('dev')->collection('users')->insert([

  'username' => 'test',

  'email'    => '[email protected]'

]);

```

### Updating a document

```

// By a specific document

$filerdb

  ->database('dev')

  ->collection('users')

  ->id('ad23tasdg')

  ->update([

    'username' => 'test2'

  ]);

// Where all usernames equal test

$filerdb

  ->database('dev')

  ->collection('users')

  ->filter(['username' => 'test'])

  ->update([

    'username' => 'test2'

  ]);

```

### Deleting a document

```

// Specific document

$filerdb

  ->database('dev')

  ->collection('users')

  ->id('asdfwegd')

  ->delete();

// With filters

$filerdb

  ->database('dev')

  ->collection('users')

  ->filter(['username' => 'test'])

  ->delete();

```

### Retrieving all documents

```

$filerdb->database('dev')->collection('users')->all()

```

### Retrieving document by id

```

$filerdb

  ->database('dev')

  ->collection('users')

  ->id('asdf23g')

  ->get();

```

### Retrieving document by filters

```

// Get users with username of test and greater than age of 10.

$filerdb

  ->database('dev')

  ->collection('users')

  ->filter(['username' => 'test'])

  ->filter([ ['age', '>', '10'] ])

  ->get();

```

### Specify fields that come back in response

```

// Only returns the username field

$filerdb

  ->database('dev')

  ->collection('users')

  ->get(['username']);

```

### Ordering documents by a field

```

// Get users with username of test and greater than age of 10.

$filerdb

  ->database('dev')

  ->collection('users')

  ->orderBy('username', 'asc')

  ->get();

```

### Limiting number of documents

```

// Pull upto 10 documents

$filerdb

  ->database('dev')

  ->collection('users')

  ->limit(10)

  ->get();

```

### Offsetting documents

```

// Pull upto 10 documents, but start at the

// 9th array key.

$filerdb

  ->database('dev')

  ->collection('users')

  ->limit(10, 9)

  ->get();

```

# Backups

You can now programmatically backup your database. You can do so by using the following code:

```

$filerdb->backup->create('file_name_here.zip');

```

This was provided so you can manually backup your database via your own command line script, or automatically via a cron job, or something similar.