mirror of https://gitee.com/bigwinds/arangodb
35 lines
4.7 KiB
Plaintext
35 lines
4.7 KiB
Plaintext
arangosh> db._help();
|
|
|
|
--------------------------- ArangoDatabase (db) help ---------------------------
|
|
Administration Functions:
|
|
_help() <span class="hljs-keyword">this</span> help
|
|
_flushCache() flush and refill collection cache
|
|
|
|
Collection Functions:
|
|
_collections() list all collections
|
|
_collection(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">name</span>></span>)</span> get collection by identifier/name
|
|
_create(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">name</span>></span>, <span class="hljs-tag"><<span class="hljs-name">properties</span>></span>)</span> creates a <span class="hljs-keyword">new</span> collection
|
|
_createEdgeCollection(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">name</span>></span>)</span> creates a <span class="hljs-keyword">new</span> edge collection
|
|
_drop(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">name</span>></span>)</span> <span class="hljs-keyword">delete</span> a collection
|
|
|
|
Document Functions:
|
|
_document(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">id</span>></span>)</span> get <span class="hljs-built_in">document</span> by handle (_id)
|
|
_replace(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">id</span>></span>, <span class="hljs-tag"><<span class="hljs-name">data</span>></span>, <span class="hljs-tag"><<span class="hljs-name">overwrite</span>></span>)</span> overwrite <span class="hljs-built_in">document</span>
|
|
_update(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">id</span>></span>, <span class="hljs-tag"><<span class="hljs-name">data</span>></span>, <span class="hljs-tag"><<span class="hljs-name">overwrite</span>></span>, partially update document
|
|
<span class="hljs-tag"><<span class="hljs-name">keepNull</span>></span>)</span>
|
|
_remove(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">id</span>></span>)</span> <span class="hljs-keyword">delete</span> <span class="hljs-built_in">document</span>
|
|
_exists(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">id</span>></span>)</span> checks whether a <span class="hljs-built_in">document</span> exists
|
|
_truncate() <span class="hljs-keyword">delete</span> all documents
|
|
|
|
Database Management Functions:
|
|
_createDatabase(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">name</span>></span>)</span> creates a <span class="hljs-keyword">new</span> database
|
|
_dropDatabase(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">name</span>></span>)</span> drops an existing database
|
|
_useDatabase(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">name</span>></span>)</span> switches into an existing database
|
|
_drop(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">name</span>></span>)</span> <span class="hljs-keyword">delete</span> a collection
|
|
_name() name <span class="hljs-keyword">of</span> the current database
|
|
|
|
Query / Transaction Functions:
|
|
_executeTransaction(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">transaction</span>></span>)</span> execute transaction
|
|
_query(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">query</span>></span>)</span> execute AQL query
|
|
_createStatement(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">data</span>></span>)</span> create and <span class="hljs-keyword">return</span> AQL query
|