# stackerjs-orm

> [![Travis](https://img.shields.io/travis/parpeoficial/stackerjs-orm.svg)](https://travis-ci.org/parpeoficial/stackerjs-orm) [![Test Coverage](https://api.codeclimate.com/v1/badges/a490f6b53e3d1cee3aaf/test_coverage)](https://codeclimate.com/github/parpeof

Latest version **1.4.2** (published 2018-06-29) · 0 weekly downloads

## Install

```sh
npm install stackerjs-orm
pnpm add stackerjs-orm
yarn add stackerjs-orm
bun add stackerjs-orm
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.2 |
| Published | 2018-06-29 |
| First published | 2018-03-05 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=7.10 |
| Dependencies | 3 |
| Unpacked size | 173.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vinicius Guedes |
| Maintainers | parpeoficial |
| Keywords | stackerjs, orm, datamapper |

## Links

- npm: https://www.npmjs.com/package/stackerjs-orm
- Repository: https://github.com/parpeoficial/stackerjs-orm
- Homepage: https://github.com/parpeoficial/stackerjs-orm#readme
- Issues: https://github.com/parpeoficial/stackerjs-orm/issues
- npm.io page: https://npm.io/package/stackerjs-orm

## Dependencies (3)

- [stackerjs-db](https://npm.io/package/stackerjs-db.md) ^1.1.2
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0
- [stackerjs-types](https://npm.io/package/stackerjs-types.md) ^1.1.2

## 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.4.2 (latest) — 2018-06-29
- 1.4.1 — 2018-06-12
- 1.4.0 — 2018-06-12
- 1.3.0 — 2018-06-08
- 1.2.0 — 2018-06-06
- 1.1.10 — 2018-06-04
- 1.1.9 — 2018-06-04
- 1.1.8 — 2018-06-04
- 1.1.7 — 2018-05-03
- 1.1.6 — 2018-05-03
- 1.1.5 — 2018-05-02
- 1.1.4 — 2018-04-26
- 1.1.3 — 2018-04-23
- 1.1.2 — 2018-04-20
- 1.1.1 — 2018-04-19
- … 14 more at https://npm.io/package/stackerjs-orm/versions

## README

[![Travis](https://img.shields.io/travis/parpeoficial/stackerjs-orm.svg)](https://travis-ci.org/parpeoficial/stackerjs-orm)
[![Test Coverage](https://api.codeclimate.com/v1/badges/a490f6b53e3d1cee3aaf/test_coverage)](https://codeclimate.com/github/parpeoficial/stackerjs-orm/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/a490f6b53e3d1cee3aaf/maintainability)](https://codeclimate.com/github/parpeoficial/stackerjs-orm/maintainability)
[![Dependencies](https://img.shields.io/david/parpeoficial/stackerjs-orm.svg)](https://david-dm.org/parpeoficial/stackerjs-orm)
[![npm](https://img.shields.io/npm/dt/stackerjs-orm.svg)](https://www.npmjs.com/package/stackerjs-orm)


[![NPM](https://nodei.co/npm/stackerjs-orm.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/stackerjs-orm/)

![StackerJS](https://s3-sa-east-1.amazonaws.com/parpe.prod/StackerJS-logo.png)

# Database: ORM
An ORM to be used inside and outside StackerJS

## Preparing
Entities must be configured:
```javascript
// Entities/User.js


export class User
{
    
    metadata()
    {
        return {
            'table': 'users',
            'fields': [
                { 'name': 'id', 'type': 'pk' },
                { 'name': 'name', 'type': 'string', 'required': true },
                { 'name': 'active', 'type': 'boolean', 'default': true }
            ],
            'relations': []
        }
    }

}
```

And then Repository is declared:
```javascript
// Repositories/UserRepository.js
import { User } from './../Entities/User';


export class UserRepository
{

    constructor()
    {
        this.entity = new User();
    }

}
```

## Inserting
```javascript
let user = new User();
user['name'] = 'My Name is...';

let usersRepository = new UserRepository();
usersRepository.save(user)
    .then(response => {
        if (!response)
            console.log(usersRepository.getErrors());

        return response;
    });
```

## Querying
```javascript
let usersRepository = new UserRepository();

// Fetching by ID
let user = await usersRepository.findById(1);

// Fetching one by filter as string
let user = await usersRepository.findOne("active = 1");

//Fetching many by filter as object
let user = await usersRepository.findAll({
    'active': { 'eq': true } // or 'active': [ 'eq', true ]
});
```

### Comparisions
| Term | MySQL Term | Description |
| ---- | --- | --- |
| eq | = | Looks for exactly equal results |
| neq | <> | Looks for exactly different |
| gt | > | Looks for greater values |
| gte | >= | Looks for greater or equal values |
| lt | < | Looks for lower values |
| lte | <= | Looks for lower or equal values |
| in | IN | Looks for values inside array |
| nin | NOT INT | Looks for values not inside array |

---
_Source: https://npm.io/package/stackerjs-orm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._