https://github.com/scull7/umzug-arango

Mirror of https://gitlab.com/scull7/umzug-arango
https://github.com/scull7/umzug-arango

Last synced: over 1 year ago
JSON representation

Mirror of https://gitlab.com/scull7/umzug-arango

• Host: GitHub
• URL: https://github.com/scull7/umzug-arango
• Owner: scull7
• License: mit
• Created: 2019-02-08T03:23:41.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-08T05:09:07.000Z (over 7 years ago)
• Last Synced: 2025-01-29T19:46:42.211Z (over 1 year ago)
• Language: JavaScript
• Size: 56.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# umzug-arango

ArangoDB custom storage backend for umzug

## Usage

```javascript

const umzug = new Umzug({

  storage: '@buckeye/umzug-arango',

  storageOptions: {

    // Set your storage options here.

  },

});

```

## Configuration

The following items can be passed to the storage options object.

* `url`  - Base URL of the ArangoDB server or list of server URLs.

* `isAbsolute`  - If this option is explicityly set to `true`, the 

        `url` will be treated as the abolute database path and arangojs will

        not append the database path to it.

* `arangoVersion`  -> Numeric representation of the ArangoDB version

        the driver should expect.

* `agent`  - An http Agent instance to use for connections.

* `loadBalancingStrategy`  - Determines the behavior when multiple

        URLs are provided.

* `maxRetries`  - Determines the behavior when a request fails because

        the underlying connection to the server could not be opened.

* `username`  - Database username to use for the connection.

* `password`  - Database password to use for the connection.

* `bearerToken`  - Authorization token header value to send to the

        the database for authentication.  If this is set, then `username` and

        `password` will be ignored.

* `database`  - Name of the database we wish to connect to.

* `collectionName`  -> Name of the collection where we want to

        store the migration history.

### Defaults

The following JavaScript object contains all the default settings:

```javascript

{

  url: 'http://localhost:8529',

  isAbsolute: false,

  arangoVersion: 30000,

  agent: null,

  loadBalancingStrategy: "NONE",

  maxRetries: 0,

  username: "root",

  password: "",

  database: "umzug",

  bearerToken: null,

  collectionName: "umzug_migrations"

}

```