arrow-orm

library2.10.2jsnpmunverified

Object-relational mapping framework specifically designed for Axway's API Builder runtime (formerly Appcelerator Arrow). Version 2.10.2 is the latest stable release. It provides Model, Instance, Collection, and Connector abstractions for building data-driven APIs. Key differentiators: tight integration with API Builder connectors, auto-generated models, and support for various actions like CRUD, query, and upsert.

database

npm install arrow-orm

package ↗

INSTALL

IMPORT

SIG · ARROW-ORM

arrow-orm

databasejavascriptv2.10.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Model

✓ import { Model } from 'arrow-orm'

✗ const Model = require('arrow-orm').Model

Arrow ORM is ESM-only since v2.

Instance

✓ import { Instance } from 'arrow-orm'

✗ const Instance = require('arrow-orm').Instance

Named export for instance objects.

Collection

✓ import { Collection } from 'arrow-orm'

✗ const Collection = require('arrow-orm').Collection

Named export for collections.

Connector

✓ import { Connector } from 'arrow-orm'

✗ const Connector = require('arrow-orm').Connector

Named export for defining connectors.

Demonstrates creating a simple User model with fields, a memory connector, and saving an instance.

import { Model, Connector } from 'arrow-orm'; import { MemoryConnector } from 'arrow-orm-connector-memory'; const connector = new MemoryConnector(); const User = Model.extend('user', { fields: { name: { type: String, default: 'Jeff' }, age: { type: Number, required: true } }, connector: connector }); const user = new User({ name: 'Alice', age: 30 }); user.save((err, instance) => { if (err) console.error(err); else console.log('Created:', instance.id); });

Debug

Known issues

breakingImport paths changed in v2: previously CommonJS require('arrow-orm') no longer works; use ESM import.

fix

Switch to import { Model } from 'arrow-orm'

affects: >=2.0.0

deprecatedThe 'autogen' property in model definition is deprecated and will be removed in v3.

fix

Remove 'autogen' from model definitions.

affects: >=2.5.0

gotchaField 'length' only applies to String and Array types; using it on other types may cause unexpected behavior.

fix

Only set 'length' on fields of type String or Array.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'arrow-orm'

Package not installed or incorrect import style.

fix

Run 'npm install arrow-orm' and use import syntax: import { Model } from 'arrow-orm'

TypeError: Connector is not a constructor

Importing default export instead of named export.

fix

Use named import: import { Connector } from 'arrow-orm'

Model.extend is not a function

Attempting to use Model as a class constructor directly.

fix

Call Model.extend() to define a model, not new Model()

Upgrade

Version history

2.10.2latest on npm

Audit

Dependencies

@axway/api-builder-runtimerequiredRequired runtime for API Builder connectors and model definition.

Agent activity

17 hits · last 30 days

node

OpenAI (training)

Resources

packagearrow-orm ↗