mirror of https://gitee.com/bigwinds/arangodb
87 lines
1.7 KiB
Markdown
87 lines
1.7 KiB
Markdown
<!-- don't edit here, it's from https://@github.com/arangodb/arangojs.git / docs/Drivers/ -->
|
|
# Graph API
|
|
|
|
These functions implement the
|
|
[HTTP API for manipulating graphs](../../../..//HTTP/Gharial/index.html).
|
|
|
|
## graph.exists
|
|
|
|
`async graph.exists(): boolean`
|
|
|
|
Checks whether the graph exists.
|
|
|
|
**Examples**
|
|
|
|
```js
|
|
const db = new Database();
|
|
const graph = db.graph('some-graph');
|
|
const result = await graph.exists();
|
|
// result indicates whether the graph exists
|
|
```
|
|
|
|
## graph.get
|
|
|
|
`async graph.get(): Object`
|
|
|
|
Retrieves general information about the graph.
|
|
|
|
**Examples**
|
|
|
|
```js
|
|
const db = new Database();
|
|
const graph = db.graph('some-graph');
|
|
const data = await graph.get();
|
|
// data contains general information about the graph
|
|
```
|
|
|
|
## graph.create
|
|
|
|
`async graph.create(properties): Object`
|
|
|
|
Creates a graph with the given _properties_ for this graph's name, then returns
|
|
the server response.
|
|
|
|
**Arguments**
|
|
|
|
- **properties**: `Object`
|
|
|
|
For more information on the _properties_ object, see
|
|
[the HTTP API documentation for creating graphs](../../../..//HTTP/Gharial/Management.html).
|
|
|
|
**Examples**
|
|
|
|
```js
|
|
const db = new Database();
|
|
const graph = db.graph('some-graph');
|
|
const info = await graph.create({
|
|
edgeDefinitions: [{
|
|
collection: 'edges',
|
|
from: ['start-vertices'],
|
|
to: ['end-vertices']
|
|
}]
|
|
});
|
|
// graph now exists
|
|
```
|
|
|
|
## graph.drop
|
|
|
|
`async graph.drop([dropCollections]): Object`
|
|
|
|
Deletes the graph from the database.
|
|
|
|
**Arguments**
|
|
|
|
- **dropCollections**: `boolean` (optional)
|
|
|
|
If set to `true`, the collections associated with the graph will also be
|
|
deleted.
|
|
|
|
**Examples**
|
|
|
|
```js
|
|
const db = new Database();
|
|
const graph = db.graph('some-graph');
|
|
await graph.drop();
|
|
// the graph "some-graph" no longer exists
|
|
```
|