Database Methods

Returns the view with the given name or null if no such view exists.

Show execution results

Hide execution results

[ArangoView 88709, "example" (type arangosearch)]
[ArangoView 88709, "example" (type arangosearch)]

db._view(view-identifier)

Returns the view with the given identifier or null if no such view exists.Accessing views by identifier is discouraged for end users. End users shouldaccess views using the view name.

Examples

Get a View by name:

arangosh> db._view("demoView");

Show execution results

Hide execution results

[ArangoView 99, "demoView" (type arangosearch)]

Unknown View:

Hide execution results

null

Creates a new View.

name is a string and the name of the View. No View or collection with thesame name may already exist in the current database. For more information onvalid View names please refer to the .

type must be the string "arangosearch", as it is currently the onlysupported View type.

properties is an optional object containing View configuration specificto each View-type. Currently, only ArangoSearch Views are supported. SeeArangoSearch View definition fordetails.

Examples

arangosh> v = db._createView("example", "arangosearch");
arangosh> v.properties()
arangosh> db._dropView("example")

Show execution results

Hide execution results

[ArangoView 88701, "example" (type arangosearch)]
  "writebufferIdle" : 64, 
  "writebufferSizeMax" : 33554432, 
  "consolidationPolicy" : { 
    "type" : "tier", 
    "segmentsBytesFloor" : 2097152, 
    "segmentsBytesMax" : 5368709120, 
    "segmentsMax" : 10, 
    "segmentsMin" : 1, 
    "minScore" : 0 
  }, 
  "primarySort" : [ ], 
  "writebufferActive" : 0, 
  "consolidationIntervalMsec" : 10000, 
  "commitIntervalMsec" : 1000, 
  "links" : { 
  } 
}

Examples

List all views:

Show execution results

Hide execution results

[ 
  [ArangoView 99, "demoView" (type arangosearch)], 
  [ArangoView 88712, "exampleView" (type arangosearch)] 
]

db._dropView(name)

Drops a view named name and all its data. No error is thrown if there isno such view.

Drops a view identified by view-identifier with all its data. No error isthrown if there is no such view.

Examples

Drop a view:

arangosh> db._createView("exampleView", "arangosearch");
arangosh> db._dropView("exampleView");
arangosh> db._view("exampleView");

Hide execution results

[ArangoView 88706, "exampleView" (type arangosearch)]
null