Interface ArangoSearchView

See also Database.createView.

example

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

example

const db = new Database();
const view = db.view("some-view");
await view.drop();
// the View "some-view" no longer 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

example

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

example

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

Additionally removes the instance from the 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!

example

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

example

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