Submit a ticket My tickets
Welcome
Login  Sign up

Uniform Resource Name (URN): convention by technology

The URN is an address which aims to identify uniquely an asset in a physical system. This address describes the type of the asset too, as its positioning in the hierarchy of the physical system, independently of its representation and organization in DataGalaxy.

This new identifier ease the harvesting of metadata and building an end-to-end lineage, connecting the technologies with each other.

The generic syntax of URN is like this: 

urn:technology-urnVersion:object1Name@object1Type:object2Name @object2Type ...

The type of the object can be optional: it is useful if in the physical system, multiple object types can be found under the same parent object (for instance tables and views in a database). At each level, a default type is defined and will be considered as the implicit type of an object whose URN does not specify a type. This way, URN can be simplified:

urn:technology-urnVersion:object1Name:object2Name...

At first creation of an object in DataGalaxy using its URN, its path and typePath will be resolved based on the components of the URN, in order to put the object in the hierarchy. The URN of an object containing the URN of its parents, the platform will look for any parent the new object should be a children of. Once created, an object can be moved elsewhere in the hierarchy without impacting the capacity of updating it using its URN. This gives a lot of flexibility to organize the hierarchy of objects in the platform.

The new API endpoints available to manipulate DataGalaxy objects with their URN are describe in the online documentation of the API.

New technologies will be added to this page as we go along the definition of their URN convention.

Databases, datawarehouses, datalakes and other storages

MS SQL Server

Version URN : 1.

ObjetURN
Databaseurn:sqlserver-1:hostname%3Aport%2Fdatabase
Schemaurn:sqlserver-1:hostname%3Aport%2Fdatabase:schema@schema
Tableurn:sqlserver-1:hostname%3Aport%2Fdatabase:schema@schema:table
Viewurn:sqlserver-1:hostname%3Aport%2Fdatabase:schema@schema:view@view
Columnurn:sqlserver-1:hostname%3Aport%2Fdatabase:schema@schema:table:column
urn:sqlserver-1:hostname%3Aport%2Fdatabase:schema@schema:view@view:column
PKurn:sqlserver-1:hostname%3Aport%2Fdatabase:schema@schema:table:pkConstraintName@primarykey
FKurn:sqlserver-1:hostname%3Aport%2Fdatabase:schema@schema:table:fkName@foreignkey

Azure SQL

Version URN : 1.

ObjetURN
Databaseurn:azuresql-1:hostname%3Aport%2Fdatabase
Schemaurn:azuresql-1:hostname%3Aport%2Fdatabase:schema@schema
Tableurn:azuresql-1:hostname%3Aport%2Fdatabase:schema@schema:table
Viewurn:azuresql-1:hostname%3Aport%2Fdatabase:schema@schema:view@view
Columnurn:azuresql-1:hostname%3Aport%2Fdatabase:schema@schema:table:column
urn:azuresql-1:hostname%3Aport%2Fdatabase:schema@schema:view@view:column
PKurn:azuresql-1:hostname%3Aport%2Fdatabase:schema@schema:table:pkConstraintName@primarykey
FKurn:azuresql-1:hostname%3Aport%2Fdatabase:schema@schema:table:fkName@foreignkey

BigQuery

URN Version: 1.

ObjectURN
Projecturn:googlebigquery-1:projectId
Dataseturn:googlebigquery-1:projectId:dataset
Tableurn:googlebigquery-1:projectId:dataset:table
Viewurn:googlebigquery-1:projectId:dataset:view@view
Fieldurn:googlebigquery-1:projectId:dataset:table:field*:field@field

Databricks

URN Version: 1.

ObjectURN
Instanceurn:databricks-1:instance
Catalogurn:databricks-1:instance:catalog
Schemaurn:databricks-1:instance:catalog:schema
Tableurn:databricks-1:instance:catalog:schema:table
Viewurn:databricks-1:instance:catalog:schema:view@view
Columnurn:databricks-1:instance:catalog:schema:table:column
urn:databricks-1:instance:catalog:schema:view@view:column
PKurn:databricks-1:instance:catalog:schema:table:column:pkConstraintName@primarykey
FKurn:databricks-1:instance:catalog:schema:table:column:fkName@foreignkey

Snowflake

URN Version: 1.

ObjectURN
Accounturn:snowflake-1:accountName
Databaseurn:snowflake-1:accountName:database
Schemaurn:snowflake-1:accountName:database:schema
Tableurn:snowflake-1:accountName:database:schema:table
Viewurn:snowflake-1:accountName:database:schema:view@view
Dynamic Tableurn:snowflake-1:accountName:database:schema:dtable@dynamictable
Columnurn:snowflake-1:accountName:database:schema:table:column
urn:snowflake-1:accountName:database:schema:view@view:column
PKurn:snowflake-1:accountName:database:schema:table:column:pkConstraintName@primarykey
FKurn:snowflake-1:accountName:database:schema:table:column:fkName@foreignkey

BI tools, data visualization

Power BI

URN Version: 1.

ObjectURN
Workspaceurn:powerbi-1:tenantId:workspaceId
urn:powerbi-1:tenantId:workspaceId@workspace
Applicationurn:powerbi-1:tenantId:appId
Dashboardurn:powerbi-1:tenantId:workspaceId@workspace:dashboardId@dashboard
DataSeturn:powerbi-1:tenantId:workspaceId@workspace:datasetId@dataset
DataSet Tableurn:powerbi-1:tenantId:workspaceId@workspace:datasetId@dataset:tableName
DataSet Measureurn:powerbi-1:tenantId:workspaceId@workspace:datasetId@dataset:tableName:measureName@measure
DataSet  Columnurn:powerbi-1:tenantId:workspaceId@workspace:datasetId@dataset:tableName:columnName@column
DataFlowurn:powerbi-1:tenantId:workspaceId@workspace:dataflowId@dataflow
DataFlow Entityurn:powerbi-1:tenantId:workspaceId@workspace:dataflowId@dataflow:entityName
DataFlow Entity Attributeurn:powerbi-1:tenantId:workspaceId@workspace:dataflowId@dataflow:entityName:attributeName
Reporturn:powerbi-1:tenantId:workspaceId@workspace:reportId
urn:powerbi-1:tenantId:workspaceId@workspace:reportId@report
Report Pageurn:powerbi-1:tenantId:workspaceId@workspace:reportId@report:pageName

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.