Skip to content

Vertex

The vertex schema defines how PuppyGraph vertex maps to the catalog.

FieldTypeDescription
labelstringA user-provided name for reference in edges and queries
mappedTableSourceMappedTableSourceSchemaSpecifies how vertex maps to catalog
attributes[]AttributeSchemaSpecifies additional attribute for queries.

MappedTableSourceSchema

FieldTypeDescription
catalogstringCatalog name matches the specified catalog schema.
schemastringSchema name matches the schema inside the catalog.
tablestringTable name matches the table inside the catalog.
metaFields{"id": "string_value"}The vertex id fields inside the data source table. The id field must be string and unique.

AttributeSchema

namestringThe field name. The name must match the field name inside the data source table.
typestringThe data type of the attribute. Please refer to the attribute-types.md for specifications.