Class View

Name of the View.

Creates a View with the given options and the instance's name.

See also database.Database#createView.

Example

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

Deletes the View from the database.

Example

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

Checks whether the View exists.

Example

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

Retrieves general information about the View.

Example

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

Retrieves the View's properties.

Example

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

Renames the View and updates the instance's name to newName.

Additionally removes the instance from the database.Database's internal cache.

Note: Renaming Views may not be supported when ArangoDB is running in a cluster configuration.

Example

const db = new Database();
const view1 = db.view("some-view");
await view1.rename("other-view");
const view2 = db.view("some-view");
const view3 = db.view("other-view");
// Note all three View instances are different objects but
// view1 and view3 represent the same ArangoDB view!
Copy

Replaces the properties of the View.

Example

const db = new Database();
const view = db.view("some-view");
const result = await view.replaceProperties({
  consolidationIntervalMsec: 234
});
console.log(result.consolidationIntervalMsec); // 234
Copy

Updates the properties of the View.

Example

const db = new Database();
const view = db.view("some-view");
const result = await view.updateProperties({
  consolidationIntervalMsec: 234
});
console.log(result.consolidationIntervalMsec); // 234
Copy