1
0
Fork 0
arangodb/Documentation/Books/Drivers/js-reference-database-view-...

1.6 KiB

layout description
default These functions implement theHTTP API for accessing views

Accessing Views

These functions implement the HTTP API for accessing Views.

database.arangoSearchView

database.arangoSearchView(viewName): ArangoSearchView

{% hint 'info' %} This method is only available when targeting ArangoDB 3.4 or later, see Compatibility. {% endhint %}

Returns a ArangoSearchView instance for the given view name.

Arguments

  • viewName: string

    Name of the arangosearch view.

Examples

const db = new Database();
const view = db.arangoSearchView("potatoes");

database.listViews

async database.listViews(): Array<Object>

{% hint 'info' %} This method is only available when targeting ArangoDB 3.4 or later, see Compatibility. {% endhint %}

Fetches all views from the database and returns an array of view descriptions.

Examples

const db = new Database();

const views = await db.listViews();
// views is an array of view descriptions

database.views

async database.views([excludeSystem]): Array<View>

{% hint 'info' %} This method is only available when targeting ArangoDB 3.4 or later, see Compatibility. {% endhint %}

Fetches all views from the database and returns an array of ArangoSearchView instances for the views.

Examples

const db = new Database();

const views = await db.views();
// views is an array of ArangoSearchView instances