Skip to content

Edge

Archived PuppyGraph 0.x documentation

This is the archived 0.x documentation. For new deployments, use puppygraph/puppygraph:latest (PuppyGraph 1.x) and the current docs. The 0.x schemas and UI described here don't apply to 1.x; see Migrating from v0.

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

Field Type Description
label string A user-provided name for reference in queries
from string The from node (vertex) label
to string The to node (vertex) label
mappedTableSource MappedTableSourceSchema Specifies how edge maps to catalog
attributes []AttributeSchema Specifies additional attribute for queries

MappedTableSourceSchema

Field Type Description
catalog string Catalog name matches the specified catalog schema.
schema string Schema name matches the schema inside the catalog.
table string Table name matches the table inside the catalog.
metaFields {"id": "", "from": "", "to": ""}
  • id - The edge id fields inside the data source table. The id field must be string and unique.
  • from, to - The from, to fields inside the data source table. The from and to field must be the id of the specified node (vertex).

AttributeSchema

Field Type Description
name string The field name. The name must match the field name inside the data source table.
type string The data type of the attribute. Please refer to the attribute-types.md for specifications.