https://github.com/suissa/partitura-db

Data Access Layer para NoSQLs
https://github.com/suissa/partitura-db

Last synced: 24 days ago
JSON representation

Data Access Layer para NoSQLs

• Host: GitHub
• URL: https://github.com/suissa/partitura-db
• Owner: suissa
• Created: 2015-03-17T21:48:14.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-03-17T22:10:52.000Z (almost 10 years ago)
• Last Synced: 2024-10-30T01:46:10.495Z (2 months ago)
• Size: 90.8 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#PartituraDB

O PartituraDB é uma API com um CRUD comum para os bancos NoSQL.

Para isso vamos definir inicialmente qual será nossa API básica que todos os bancos devem implementar:

```js

{ 

  "DB": "mongo"

, "create": "insert"

, "retrieve": "find"

, "get": "findOne"

, "update": "update"

, "delete": "remove"

}

```

E qual vai ser a definição dos parâmetros dessas funções?

```js

var Partitura = require('Partitura');

// os métodos inicialmente não serão encadeados

Partitura

  .insert(JSON, callback(err, data))

  .find(JSON, callback(err, data)) 

  .findOne(JSON, callback(err, data))

  .update(JSON, callback()) 

  .update(JSON_QUERY, JSON_UPDATE ,callback(err, data)) 

  .remove(JSON, callback(err,data))

```

##API - CRUD

###Callbacks

Para usar o padrão do Node.js todo o *callback* deve aceitar 2 parâmetros:

- err: objeto retornado ao ERRO

- data: objeto retornado ao SUCESSO

Caso o *callback* seja de **sucesso** deve-se retornar `null` como primeiro parâmetro.

###Create - Insert

Função que irá inserir um objeto passado como parâmetro.

```js

function insert(JSON, callback(err, data));

// JSON é o objeto a ser inserido

```

###Retrieve - Find

Função que irá listar os objetos buscados pela query no primeiro parâmetro.

```js

function insert(JSON, callback(err, data));

// JSON é o objeto a ser inserido

```

###Update - Update

Função que irá alterar um objeto buscado via query no primeiro parâmetro e no segundo parâmetro passa-se o objeto com os valores a serem alterados.

```js

function insert(JSON, JSON, callback(err, data));

// JSON é o objeto a ser inserido

```

###Delete - Remove

Função que irá deletar um objeto buscado via query como parâmetro.

```js

function insert(JSON, callback(err, data));

// JSON é o objeto a ser inserido

```