Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codemix/oriento
Former official node.js driver for OrientDB. Fast, lightweight, uses the binary protocol. Now deprecated.
https://github.com/codemix/oriento
Last synced: 13 days ago
JSON representation
Former official node.js driver for OrientDB. Fast, lightweight, uses the binary protocol. Now deprecated.
- Host: GitHub
- URL: https://github.com/codemix/oriento
- Owner: codemix
- License: other
- Created: 2014-03-05T22:48:02.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-06-26T16:57:28.000Z (over 9 years ago)
- Last Synced: 2024-09-18T03:02:17.829Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 3.39 MB
- Stars: 196
- Watchers: 31
- Forks: 34
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# NOTE: Oriento is deprecated, development continues at https://github.com/orientechnologies/orientjs
# Oriento
Official [orientdb](http://www.orientechnologies.com/orientdb/) driver for node.js. Fast, lightweight, uses the binary protocol.
[](https://travis-ci.org/codemix/oriento)
[](https://gitter.im/codemix/oriento)
# Supported Versions
Oriento aims to work with version 1.7.1 of orientdb and later. While it may work with earlier versions, they are not currently supported, [pull requests are welcome!](./CONTRIBUTING.md)
> **IMPORTANT**: Oriento does not currently support OrientDB's Tree Based [RIDBag](https://github.com/orientechnologies/orientdb/wiki/RidBag) feature because it relies on making additional network requests.
> This means that by default, the result of e.g. `JSON.stringify(record)` for a record with up to 119 edges will be very different from a record with 120+ edges.
> This can lead to very nasty surprises which may not manifest themselves during development but could appear at any time in production.
> There is an [open issue](https://github.com/orientechnologies/orientdb/issues/2315) for this in OrientDB, until that gets fixed, it is **strongly recommended** that you set `RID_BAG_EMBEDDED_TO_SBTREEBONSAI_THRESHOLD` to a very large value, e.g. 2147483647.
> Please see the [relevant section in the OrientDB manual](http://www.orientechnologies.com/docs/2.0/orientdb.wiki/RidBag.html#configuration) for more information.
# Installation
Install via npm.
```sh
npm install oriento
```
# Running Tests
To run the test suite, first invoke the following command within the repo, installing the development dependencies:
```sh
npm install
```
Then run the tests:
```sh
npm test
```
# Features
- Tested with latest orientdb (1.7).
- Intuitive API, based on [bluebird](https://github.com/petkaantonov/bluebird) promises.
- Fast binary protocol parser.
- Access multiple databases via the same socket.
- Migration support.
- Simple CLI.
- Connection Pooling
# Usage
### Configuring the client.
```js
var Oriento = require('oriento');
var server = Oriento({
host: 'localhost',
port: 2424,
username: 'root',
password: 'yourpassword'
});
```
### Listing the databases on the server
```js
server.list()
.then(function (dbs) {
console.log('There are ' + dbs.length + ' databases on the server.');
});
```
### Creating a new database
```js
server.create({
name: 'mydb',
type: 'graph',
storage: 'plocal'
})
.then(function (db) {
console.log('Created a database called ' + db.name);
});
```
### Using an existing database
```js
var db = server.use('mydb');
console.log('Using database: ' + db.name);
```
### Using an existing database with credentials
```js
var db = server.use({
name: 'mydb',
username: 'admin',
password: 'admin'
});
console.log('Using database: ' + db.name);
```
### Execute an Insert Query
```js
db.query('insert into OUser (name, password, status) values (:name, :password, :status)',
{
params: {
name: 'Radu',
password: 'mypassword',
status: 'active'
}
}
).then(function (response){
console.log(response); //an Array of records inserted
});
```
### Execute a Select Query with Params
```js
db.query('select from OUser where name=:name', {
params: {
name: 'Radu'
},
limit: 1
}).then(function (results){
console.log(results);
});
```
### Raw Execution of a Query String with Params
```js
db.exec('select from OUser where name=:name', {
params: {
name: 'Radu'
}
}).then(function (response){
console.log(response.results);
});
```
### Query Builder: Insert Record
```js
db.insert().into('OUser').set({name: 'demo', password: 'demo', status: 'ACTIVE'}).one()
.then(function (user) {
console.log('created', user);
});
```
### Query Builder: Update Record
```js
db.update('OUser').set({password: 'changed'}).where({name: 'demo'}).scalar()
.then(function (total) {
console.log('updated', total, 'users');
});
```
### Query Builder: Delete Record
```js
db.delete().from('OUser').where({name: 'demo'}).limit(1).scalar()
.then(function (total) {
console.log('deleted', total, 'users');
});
```
### Query Builder: Select Records
```js
db.select().from('OUser').where({status: 'ACTIVE'}).all()
.then(function (users) {
console.log('active users', users);
});
```
### Query Builder: Text Search
```js
db.select().from('OUser').containsText({name: 'er'}).all()
.then(function (users) {
console.log('found users', users);
});
```
### Query Builder: Select Records with Fetch Plan
```js
db.select().from('OUser').where({status: 'ACTIVE'}).fetch({role: 5}).all()
.then(function (users) {
console.log('active users', users);
});
```
### Query Builder: Select an expression
```js
db.select('count(*)').from('OUser').where({status: 'ACTIVE'}).scalar()
.then(function (total) {
console.log('total active users', total);
});
```
### Query Builder: Traverse Records
```js
db.traverse().from('OUser').where({name: 'guest'}).all()
.then(function (records) {
console.log('found records', records);
});
```
### Query Builder: Return a specific column
```js
db
.select('name')
.from('OUser')
.where({status: 'ACTIVE'})
.column('name')
.all()
.then(function (names) {
console.log('active user names', names.join(', '));
});
```
### Query Builder: Transform a field
```js
db
.select('name')
.from('OUser')
.where({status: 'ACTIVE'})
.transform({
status: function (status) {
return status.toLowerCase();
}
})
.limit(1)
.one()
.then(function (user) {
console.log('user status: ', user.status); // 'active'
});
```
### Query Builder: Transform a record
```js
db
.select('name')
.from('OUser')
.where({status: 'ACTIVE'})
.transform(function (record) {
return new User(record);
})
.limit(1)
.one()
.then(function (user) {
console.log('user is an instance of User?', (user instanceof User)); // true
});
```
### Query Builder: Specify default values
```js
db
.select('name')
.from('OUser')
.where({status: 'ACTIVE'})
.defaults({
something: 123
})
.limit(1)
.one()
.then(function (user) {
console.log(user.name, user.something);
});
```
### Query Builder: Put a map entry into a map
```js
db
.update('#1:1')
.put('mapProperty', {
key: 'value',
foo: 'bar'
})
.scalar()
.then(function (total) {
console.log('updated', total, 'records');
});
```
### Loading a record by RID.
```js
db.record.get('#1:1')
.then(function (record) {
console.log('Loaded record:', record);
});
```
### Deleting a record
```js
db.record.delete('#1:1')
.then(function () {
console.log('Record deleted');
});
```
### Listing all the classes in the database
```js
db.class.list()
.then(function (classes) {
console.log('There are ' + classes.length + ' classes in the db:', classes);
});
```
### Creating a new class
```js
db.class.create('MyClass')
.then(function (MyClass) {
console.log('Created class: ' + MyClass.name);
});
```
### Creating a new class that extends another
```js
db.class.create('MyOtherClass', 'MyClass')
.then(function (MyOtherClass) {
console.log('Created class: ' + MyOtherClass.name);
});
```
### Getting an existing class
```js
db.class.get('MyClass')
.then(function (MyClass) {
console.log('Got class: ' + MyClass.name);
});
```
### Updating an existing class
```js
db.class.update({
name: 'MyClass',
superClass: 'V'
})
.then(function (MyClass) {
console.log('Updated class: ' + MyClass.name + ' that extends ' + MyClass.superClass);
});
```
### Listing properties in a class
```js
MyClass.property.list()
.then(function (properties) {
console.log('The class has the following properties:', properties);
});
```
### Adding a property to a class
```js
MyClass.property.create({
name: 'name',
type: 'String'
})
.then(function () {
console.log('Property created.')
});
```
### Deleting a property from a class
```js
MyClass.property.drop('myprop')
.then(function () {
console.log('Property deleted.');
});
```
### Renaming a property on a class
```js
MyClass.property.rename('myprop', 'mypropchanged');
.then(function () {
console.log('Property renamed.');
});
```
### Creating a record for a class
```js
MyClass.create({
name: 'John McFakerton',
email: '[email protected]'
})
.then(function (record) {
console.log('Created record: ', record);
});
```
### Listing records in a class
```js
MyClass.list()
.then(function (records) {
console.log('Found ' + records.length + ' records:', records);
});
```
### Create a new index for a class property
```js
db.index.create({
name: 'MyClass.myProp',
type: 'unique'
})
.then(function(index){
console.log('Created index: ', index);
});
```
### Get entry from class property index
```js
db.index.get('MyClass.myProp')
.then(function (index) {
index.get('foo').then(console.log.bind(console));
});
```
### Creating a new, empty vertex
```js
db.create('VERTEX', 'V').one()
.then(function (vertex) {
console.log('created vertex', vertex);
});
```
### Creating a new vertex with some properties
```js
db.create('VERTEX', 'V')
.set({
key: 'value',
foo: 'bar'
})
.one()
.then(function (vertex) {
console.log('created vertex', vertex);
});
```
### Deleting a vertex
```js
db.delete('VERTEX')
.where('@rid = #12:12')
.one()
.then(function (count) {
console.log('deleted ' + count + ' vertices');
});
```
### Creating a simple edge between vertices
```js
db.create('EDGE', 'E')
.from('#12:12')
.to('#12:13')
.one()
.then(function (edge) {
console.log('created edge:', edge);
});
```
### Creating an edge with properties
```js
db.create('EDGE', 'E')
.from('#12:12')
.to('#12:13')
.set({
key: 'value',
foo: 'bar'
})
.one()
.then(function (edge) {
console.log('created edge:', edge);
});
```
### Deleting an edge between vertices
```js
db.delete('EDGE', 'E')
.from('#12:12')
.to('#12:13')
.scalar()
.then(function (count) {
console.log('deleted ' + count + ' edges');
});
```
### Creating a function
You can create a function by supplying a plain javascript function. Please note that the method stringifies the `function` passed so you can't use any varaibles outside the function closure.
```js
db.createFn("nameOfFunction", function(arg1, arg2) {
return arg1 + arg2;
})
.then(function (count) {
// Function created!
});
```
You can also omit the name and it'll default to the `Function#name`
```js
db.createFn(function nameOfFunction(arg1, arg2) {
return arg1 + arg2;
})
.then(function (count) {
// Function created!
});
```
# CLI
An extremely minimalist command line interface is provided to allow
databases to created and migrations to be applied via the terminal.
To be useful, oriento requires some arguments to authenticate against the server. All operations require the `password` argument unless the user is configured with an empty password. For operations that involve a specific db, include the `dbname` argument (with `dbuser` and `dbpassword` if they are set to something other than the default).
You can get a list of the supported arguments using `oriento --help`.
```sh
-d, --cwd The working directory to use.
-h, --host The server hostname or IP address.
-p, --port The server port.
-u, --user The server username.
-s, --password The server password.
-n, --dbname The name of the database to use.
-U, --dbuser The database username.
-P, --dbpassword The database password.
-?, --help Show the help screen.
```
If it's too tedious to type these options in every time, you can also create an `oriento.opts` file containing them. Oriento will search for this file in the working directory and apply any arguments it contains.
For an example of such a file, see [test/fixtures/oriento.opts](./test/fixtures/oriento.opts).
> Note: For brevity, all these examples assume you've installed oriento globally (`npm install -g oriento`) and have set up an oriento.opts file with your server and database credentials.
## Database CLI Commands.
### Listing all the databases on the server.
```sh
oriento db list
```
### Creating a new database
```sh
oriento db create mydb graph plocal
```
### Destroying an existing database
```sh
oriento db drop mydb
```
## Migrations
Oriento supports a simple database migration system. This makes it easy to keep track of changes to your orientdb database structure between multiple environments and distributed teams.
When you run a migration command, oriento first looks for an orient class called `Migration`. If this class doesn't exist it will be created.
This class is used to keep track of the migrations that have been applied.
Oriento then looks for migrations that have not yet been applied in a folder called `migrations`. Each migration consists of a simple node.js module which exports two methods - `up()` and `down()`. Each method receives the currently selected database instance as an argument.
The `up()` method should perform the migration and the `down()` method should undo it.
> Note: Migrations can incur data loss! Make sure you back up your database before migrating up and down.
In addition to the command line options outlined below, it's also possible to use the migration API programatically:
```js
var db = server.use('mydb');
var manager = new Oriento.Migration.Manager({
db: db,
dir: __dirname + '/migrations'
});
manager.up(1)
.then(function () {
console.log('migrated up by one!')
});
```
### Listing the available migrations
To list all the unapplied migrations:
```sh
oriento migrate list
```
### Creating a new migration
```sh
oriento migrate create my new migration
```
creates a file called something like `m20140318_200948_my_new_migration` which you should edit to specify the migration up and down methods.
### Migrating up fully
To apply all the migrations:
```sh
oriento migrate up
```
### Migrating up by 1
To apply only the first migration:
```sh
oriento migrate up 1
```
### Migrating down fully
To revert all migrations:
```sh
oriento migrate down
```
### Migrating down by 1
```sh
oriento migrate down 1
```
## Events
You can also bind to the following events
### `beginQuery`
Given the query
db.select('name, status').from('OUser').where({"status": "active"}).limit(1).fetch({"role": 1}).one();
The following event will be triggered
db.on("beginQuery", function(obj) {
// => {
// query: 'SELECT name, status FROM OUser WHERE status = :paramstatus0 LIMIT 1',
// mode: 'a',
// fetchPlan: 'role:1',
// limit: -1,
// params: { params: { paramstatus0: 'active' } }
// }
});
### `endQuery`
After a query has been run, you'll get the the following event emitted
db.on("endQuery", function(obj) {
// => {
// "err": errObj,
// "result": resultObj,
// "perf": {
// "query": timeInMs
// }
// }
});
# History
In 2012, [Gabriel Petrovay](https://github.com/gabipetrovay) created the original [node-orientdb](https://github.com/gabipetrovay/node-orientdb) library, with a straightforward callback based API.
In early 2014, [Giraldo Rosales](https://github.com/nitrog7) made a [whole host of improvements](https://github.com/nitrog7/node-orientdb), including support for orientdb 1.7 and switched to a promise based API.
Later in 2014, [codemix](http://codemix.com/) refactored the library to make it easier to extend and maintain, and introduced an API similar to [nano](https://github.com/dscape/nano). The result is so different from the original codebase that it warranted its own name and npm package. This also gave us the opportunity to switch to semantic versioning.
# Notes for contributors
Please see [CONTRIBUTING](./CONTRIBUTING.md).
# Changes
See [CHANGELOG](./CHANGELOG.md)
# License
Apache 2.0 License, see [LICENSE](./LICENSE.md)