View API

These functions implement the HTTP API for manipulating Views.

Views were introduced in ArangoDB 3.4 and are not supported by earlier versions of ArangoDB.

view.exists

async view.exists(): boolean

Checks whether the View exists.

Examples

const db = new Database();
const view = db.arangoSearchView("some-view");
const result = await view.exists();
// result indicates whether the View exists

view.get

async view.get(): Object

Retrieves general information about the View.

Examples

const db = new Database();
const view = db.arangoSearchView("some-view");
const data = await view.get();
// data contains general information about the View

view.properties

async view.properties(): Object

Retrieves the View’s properties.

Examples

const db = new Database();
const view = db.arangoSearchView("some-view");
const data = await view.properties();
// data contains the View's properties

view.create

async view.create([properties]): Object

Creates a View with the given properties for this View’s name, then returns the server response.

Arguments

Examples

const db = new Database();
const view = db.arangoSearchView("potatoes");
await view.create();
// the ArangoSearch View "potatoes" now exists

view.setProperties

async view.setProperties(properties): Object

Updates the properties of the View.

Arguments

Examples

const db = new Database();
const view = db.arangoSearchView("some-view");
const result = await view.setProperties({ consolidationIntervalMsec: 123 });
assert.equal(result.consolidationIntervalMsec, 123);

view.replaceProperties

async view.replaceProperties(properties): Object

Replaces the properties of the View.

Arguments

Examples

const db = new Database();
const view = db.arangoSearchView("some-view");
const result = await view.replaceProperties({ consolidationIntervalMsec: 234 });
assert.equal(result.consolidationIntervalMsec, 234);

view.rename

async view.rename(name): Object

Renames the View. The View instance will automatically update its name when the rename succeeds.

Examples

const db = new Database();
const view = db.arangoSearchView("some-view");
const result = await view.rename("new-view-name");
assert.equal(result.name, "new-view-name");
assert.equal(view.name, result.name);
// result contains additional information about the View

view.drop

async view.drop(): Object

Deletes the View from the database.

Examples

const db = new Database();
const view = db.arangoSearchView("some-view");
await view.drop();
// the View "some-view" no longer exists