Skip to content

Types

Label

Ƭ Label: string

Label set in create property graph query

OracleResponse

Ƭ OracleResponse<ND, ED>: Object

Object returned by CUST_SQLGRAPH_JSON function

Type declaration

NameType
edges{ id: SQLID ; properties: ED ; source: SQLID ; target: SQLID }[]
vertices{ id: SQLID ; properties: ND }[]

ParserOptions

Ƭ ParserOptions<ND, ED>: Object

Type declaration

NameType
SQLIDfromId?SQLIDfromIdFn
SQLIDtoId?SQLIDtoIdFn
labelFromId?(id: string) => string
parseFn?parseFn<ND, ED>
rowId?(id: string) => string

RowId

Ƭ RowId: number

Row ID of a node or edge in the database

SQLID

Ƭ SQLID: `${Label}{"ID": ${RowId}}`

ID Format used by CUST_SQLGRAPH_JSON

  • Label is the label set in create property graph query
  • RowId is the rowid of the node or edge in the database

SQLIDfromIdFn

Ƭ SQLIDfromIdFn: (id: string) => SQLID

Type declaration

▸ (id): SQLID

Function to transform back a string id to a SQL ID

Parameters
NameType
idstring
Returns

SQLID

SQLIDtoIdFn

Ƭ SQLIDtoIdFn: (id: SQLID) => string

Type declaration

▸ (id): string

Function used within parse functions to generate the id of a node or edge from its SQLID

Parameters
NameType
idSQLID
Returns

string

parseFn

Ƭ parseFn<ND, ED>: (opts: OracleResponse<ND, ED>) => { edges: RawEdge<ED>[] ; nodes: RawNode<ND>[] }

Type declaration

▸ (opts): Object

Parameters
NameType
optsOracleResponse<ND, ED>
Returns

Object

NameType
edgesRawEdge<ED>[]
nodesRawNode<ND>[]