schema-graphs.md

Schema manager - Graphs

You can use the schema manager to perform CRUD actions on named graphs.

Graph functions

The schema manager supports the following graph functions:

createGraph(string $name, array $config = [], $waitForSync = false): stdClass

$arangoClient->schema()->createGraph(
    'relations',
    [
        'edgeDefinitions' => [
            [
                'collection' => 'children',
                'from' => ['characters'],
                'to' => ['characters']
            ]
        ],
        'orphanCollections' => [
            'orphanVertices'
        ],
    ],
    true
);

getGraph(string $name): stdClass

$arangoClient->schema()->getGraphs('relations');

getGraphs(): array

$arangoClient->schema()->getGraphs();

hasGraph(string $name): bool

$arangoClient->schema()->hasGraph('relations');

deleteGraph(string $name): bool

$arangoClient->schema()->deleteGraph('locations');

deleteAllGraphs(): bool

This method deletes all named graphs available on the current database.

$arangoClient->schema()->deleteAllGraphs();

getGraphVertices(string $name): array

$arangoClient->schema()->getGraphVertices('relations');

addGraphVertex(string $name, string $vertex): stdClass

$arangoClient->schema()->addGraphVertex('relations', 'houses');

removeGraphVertex(string $name, string $vertex, bool $dropCollection = false): stdClass

$arangoClient->schema()->removeGraphVertex('relations', 'houses', true);

getGraphEdges(string $name): array

$arangoClient->schema()->deleteGraph('locations');

addGraphEdge(string $name, array $edgeDefinition): stdClass

$arangoClient->schema()->addGraphEdge(
    'relations', 
     [
        'collection' => 'vassals',
        'from' => ['characters'],
        'to' => ['houses']
    ]
);

replaceGraphEdge(string $name, string $edge, array $edgeDefinition, bool $dropCollection = false, bool $waitForSync = false): stdClass

$arangoClient->schema()->createGraph(
    'relations',
    [
        'edgeDefinitions' => [
            [
                'collection' => 'children',
                'from' => ['characters'],
                'to' => ['characters']
            ]
        ]
    ]
);

removeGraphEdge(string $name, string $edge, bool $dropCollection = true, bool $waitForSync = false): stdClass

$arangoClient->schema()->removeGraphEdge(
    'relations',
    'children',
    true,
    true
);