Declares an object type in the graph’s ontology: a name plus property definitions (value_type, required). While the ontology is a draft, redefining a type replaces it freely. After graph.ontology.freeze, the ontology is immutable and this command fails with failed_precondition.engine.graph_ontology_frozen.
Successful mutations return an acknowledgement that identifies the affected target, the mutation effect, and commit facts when the operation changed stored state.
Examples
Define an object (node) type.
CLI
$ strata graph create g
$ strata graph ontology define-object-type g person
$ strata graph ontology summary g
Wire
{"graph":"g","type":"graph_create"}
{"graph":"g","name":"person","type":"graph_define_object_type"}
{"graph":"g","type":"graph_ontology_summary"}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
graph | string | yes | Graph name. |
name | string | yes | Object type name. |
properties | object | no | Declared properties by name. |
Plus the optional scope: branch and space (default to the session branch and the "default" space).
Returns
MutationAck<GraphOntologyWrite>.
Errors
failed_precondition.engine.runtime_closednot_found.engine.branchinvalid_argument.engine.product_spaceinvalid_argument.engine.graph_namenot_found.engine.graphinvalid_argument.engine.graph_type_nameinvalid_argument.engine.graph_type_name_reservedinvalid_argument.engine.graph_property_namefailed_precondition.engine.graph_ontology_frozen
Invocation
- CLI:
strata graph ontology define-object-type - Wire type:
graph_define_object_type