graph-model
Manage graph models (knowledge graph)
Authentication scope: fabric
List graph models in a workspace
fabio graph-model list --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Show details of a graph model
fabio graph-model show --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Graph model ID |
Read-only · Returns object
create
Section titled “create”Create a new graph model
fabio graph-model create --workspace <value> --name <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--name |
string |
Yes | Display name |
--description |
string |
No | Optional description |
--ontology |
string |
No | Ontology ID to link the graph model to |
--sensitivity-label |
string |
No | Sensitivity label ID to apply on creation |
Examples
fabio graph-model create --workspace $WS --name "FactoryGraph" --ontology $ONTMutates state · Returns object
update
Section titled “update”Update graph model properties (name and/or description)
fabio graph-model update --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Graph model ID |
--name |
string |
No | New display name |
--description |
string |
No | New description |
Mutates state · Returns object
delete
Section titled “delete”Delete a graph model
fabio graph-model delete --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Graph model ID |
--hard-delete |
bool |
No | Permanently delete (cannot be recovered) |
Mutates state · Destructive · Returns void
get-definition
Section titled “get-definition”Get the definition of a graph model
fabio graph-model get-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Graph model ID |
--decode |
bool |
No | Decode base64 payloads inline (adds decodedPayload field) |
Read-only · Long-running operation · Returns object
update-definition
Section titled “update-definition”Update the definition of a graph model
fabio graph-model update-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Graph model ID |
--file |
string |
No | Path to definition file |
--content |
string |
No | Inline definition content |
Mutates state · Long-running operation · Returns void
refresh-graph
Section titled “refresh-graph”Trigger a graph refresh job
fabio graph-model refresh-graph --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Graph model ID |
--wait |
bool |
No | Wait for the refresh to complete |
--timeout |
string |
No | Timeout in seconds when using –wait (default: 600) |
Mutates state · Long-running operation · Returns object
execute-query
Section titled “execute-query”Execute a GQL query against the graph
fabio graph-model execute-query --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Graph model ID |
--gql |
string |
No | GQL query text (ISO/IEC 39075). Use @file.gql to read from a file, or omit to pipe via stdin. Named --gql to avoid clashing with the global --query JMESPath projection flag |
Examples
fabio graph-model execute-query --workspace $WS --id $GM --gql "MATCH (e:Equipment) WHERE e.status = 'Offline' RETURN e LIMIT 100"Read-only · Returns object
get-queryable-graph-type
Section titled “get-queryable-graph-type”Get the queryable graph type
fabio graph-model get-queryable-graph-type --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Graph model ID |
Read-only · Returns object
initialize
Section titled “initialize”Initialize a graph model for querying (portal-only operation)
fabio graph-model initialize --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Graph model ID |
Mutates state · Returns object