# orango
> ArangoDB Object Modeler for Node.js, Foxx and Web Browsers
Latest version **1.0.0-beta-1.1** (published 2019-07-03) · MIT license · 0 weekly downloads
> **Deprecated.** This package is deprecated.
## Install
```sh
npm install orango
pnpm add orango
yarn add orango
bun add orango
```
## Health
**Score 10/100 (F)** — status: deprecated.
Negative: deprecated.
## Facts
| | |
|---|---|
| Version | 1.0.0-beta-1.1 |
| Published | 2019-07-03 |
| First published | 2018-08-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 388.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rob Taylor |
| Maintainers | roboncode |
| Keywords | arangodb, arangojs, foxx, document, model, schema, database, odm, datastore, query, nosql, orm, db |
## Links
- npm: https://www.npmjs.com/package/orango
- Repository: https://github.com/roboncode/orango
- Homepage: https://orango.js.org
- Issues: https://github.com/roboncode/orango/issues
- npm.io page: https://npm.io/package/orango
## Dependencies (7)
- [colors](https://npm.io/package/colors.md) 1.3.3
- [dotenv](https://npm.io/package/dotenv.md) 6.2.0
- [tangjs](https://npm.io/package/tangjs.md) ^0.3.1
- [uniqid](https://npm.io/package/uniqid.md) ^5.0.3
- [winston](https://npm.io/package/winston.md) ^3.1.0
- [arangojs](https://npm.io/package/arangojs.md) 6.10.0
- [pluralize](https://npm.io/package/pluralize.md) ^7.0.0
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 1.0.0-beta-1.1 (latest) — 2019-07-03
- 1.0.0-alpha-2.0.14 (next) — 2019-02-05
- 1.0.0-alpha-2.5 — 2019-03-11
- 1.0.0-alpha-2.4 — 2019-03-03
- 1.0.0-alpha-2.3 — 2019-03-03
- 1.0.0-alpha-2.2 — 2019-02-26
- 1.0.0-alpha-2.1 — 2019-02-10
- 1.0.0-alpha-2.0.13 — 2019-02-01
- 1.0.0-alpha-2.0.12 — 2019-01-30
- 1.0.0-alpha-2.0.11 — 2019-01-30
- 1.0.0-alpha-2.0.10 — 2019-01-14
- 1.0.0-alpha-1.2 — 2019-01-14
- 1.0.0-alpha-2.0.8 — 2019-01-08
- 1.0.0-alpha-2.0.7 — 2019-01-01
- 1.0.0-alpha-2.0.6 — 2019-01-01
- … 30 more at https://npm.io/package/orango/versions
## README
# 
ArangoDB Object Modeling for Node.js, Foxx and Modern Web Browsers
[](https://travis-ci.com/roboncode/orango)
[](https://coveralls.io/github/roboncode/orango?branch=master)
[](http://commitizen.github.io/cz-cli/)
**Orango** is an **ODM** (Object Data Modeler), an **ORM** (Object Relational Mapper) and an **OGM** (Object Graphical Mapper) in one that provides the following features:
* Central connectivity to ArangoDB
* Automated creation of collections and indexes
* Create schemas for data
* Interact with models to handle data-centric functionality
* Pre-populate database
* Graph linking and querying
* and more...
### Why use Orango with ArangoDB?
* Ease of use
* Model-driven data
* Focus on data instead of queries
* Optimized query creation
* Validation
* Filter unknown data from being injected into database
* Cleaner interfaces
* Single point of change for bug fixes, features, etc
* Save on redundancy - DRY implementation
* Default values
* and more...
### Community Support
### Documentation & Articles
Official documentation can be found at **[orango.js.org](https://orango.js.org)**. *(This is a work in progress)*
I will be regularly posting articles on CodeBurst.io (Medium). Follow me there https://codeburst.io/@roboncode
Follow me on Twitter https://twitter.com/@roboncode for updates
### Installation
First be sure you have ArangoDB and Node.js installed. You can install ArangoDB using the [official docker container](https://hub.docker.com/r/arangodb/arangodb/).
Next, install Orango from the command line using `npm`:
```cmd
$ npm install orango
```
### Importing
```js
// Using Node.js `require()`
const orango = require('orango')
// Using ES6 imports
import orango from 'orango'
```
## Overview
### Connecting to ArangoDB
First, we need to define a connection. If your app uses the default `_system` database, you can connect using `orango.connect()`. If you need to create additional connections, use `orango.get( database:String ).connect()`.
The method `connect([{url:String="http://localhost:8529", username:String, password:String}])` takes database name with options to establish a connection. Otherwise, it will use the default values.
```js
const orango = require('orango')
const { EVENTS } = orango.consts
orango.events.once(EVENTS.CONNECTED, conn => {
console.log('🥑 Connected to ArangoDB:', conn.url + '/' + conn.name)
})
orango.events.once(EVENTS.READY, () => {
console.log('🍊 Orango is ready!')
})
async function main() {
await orango.connect()
}
main()
```
> **Note:** Orango buffers model definitions, so they can be defined before or after a connection is established.
### Defining a Model
```js
const schema = new orango.Schema({
author: String,
title: String,
body: String,
date: Date
})
orango.model('Blog', schema)
```
Aside from defining the structure of your documents and data types, Orango models can handle the definition of:
* Validators
* Default values
* Indexes
* Static methods
* Computed properties
* Hooks
* Custom queries
* Unknown property filters
* JSON to model structures
* Joi definitions
The following example shows some of these features:
```js
const Joi = require('joi')
const { SCHEMA } = orango.consts
class UserSchema extends orango.Schema {
// computed properties
get fullName() {
return (this.firstName + ' ' + this.lastName).trim()
}
}
let schema = new UserSchema({
firstName: String,
lastName: String,
// Joi can be used directly
email: Joi.string().email(),
// JSON gets converted to Joi data types automatically
age: { type: Number, min: 18 },
bio: { type: String, regex: /[a-z]/ },
// default values are supported on insert and update
created: { type: Date, default: Date.now },
updated: { type: Date, defaultOnUpdate: Date.now }
})
schema.addIndex(SCHEMA.INDEX.HASH, 'email')
schema.addIndex(SCHEMA.INDEX.SKIP_LIST, ['firstName', 'lastName'])
let User = orango.model('User', schema)
// extend your model with custom functions
User.findByEmail = async function(email) {
return await this.find().one().where({ email })
}
```
**In code somewhere else**
```js
const User = orango.model('User')
...
let user = await User.findByEmail('john.smith@gmail.com').return({ model: true })
console.log('Hello,', user.name) // access model getter
```
### Examples
A growing set of examples are available [here](examples). To run the examples, `clone` this project and then run the Orango docker containers.
#### Install dependencies
```cmd
npm install
```
#### Run the docker containers provided by Orango
**Linux and Mac**
Run the ArangoDB containers provided by Orango.
```cmd
$ make dbs
```
**Windows**
```cmd
$ cd docker & docker-compose up -d
```
#### Run examples
```cmd
npm run examples
```
You will be presented with a wizard where you can run different examples files.
#### Debugging the examples with VSCode
Setup your config like the example below. You can launch any number of the snippets by placing the snippet you would like to start in the `args` array. Then run the debugger. The output will be in the `Debug Console`.
```json
{
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Count",
"program": "${workspaceFolder}/examples/debug.js",
"args": ["count"]
},
{
"type": "node",
"request": "launch",
"name": "Find First",
"program": "${workspaceFolder}/examples/debug.js",
"args": ["find_first"]
}
]
}
```
#### License
[MIT](LICENSE)
Copyright (c) 2018-present, Rob Taylor
---
_Source: https://npm.io/package/orango · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._