OBJECT_ID_FROM_EDGE_ID (Transact-SQL)
Applies to: SQL Server 2017 (14.x) and later Azure SQL Database Azure SQL Managed Instance
Returns the object ID for a given graph edge ID.
Syntax
OBJECT_ID_FROM_EDGE_ID ( edge_id )
Arguments
edge_id
The $edge_id
pseudo-column in a graph edge table.
Return value
Returns the object_id
for the graph table corresponding to the edge_id
supplied. object_id
is an int. If an invalid edge_id
is supplied, NULL is returned.
Remarks
- Owing to the performance overhead of parsing and validating the supplied character representation (JSON) of edges, you should only use
OBJECT_ID_FROM_EDGE_ID
where needed. In most cases, MATCH should be sufficient for queries over graph tables. - For
OBJECT_ID_FROM_EDGE_ID
to return a value, the supplied character representation (JSON) of the edge ID must be valid, and the namedschema.table
within the JSON, must be a valid edge table. The graph ID within the character representation (JSON), need not exist in the edge table. It can be any valid integer. OBJECT_ID_FROM_EDGE_ID
is the only supported way to parse the character representation (JSON) of an edge ID.
Examples
The following example returns the object_id
for all the $edge_id
nodes in the likes
graph edge table. In the SQL Graph Database Sample, the values returned are constant and equal to the object_id
of the likes
table (978102525 in this example).
SELECT OBJECT_ID_FROM_EDGE_ID($from_id)
FROM likes;
Here are the results:
...
978102525
978102525
978102525
...