Skip to main content

Properties

This section is about Timbr SQL Data Definition Language (DDL) queries to create and edit properties and their tags.

Create or replace property​

Create and edit properties in the knowledge graph

Required information for creating or replacing a property (the curly brackets {} should not be an input, they are used only as a variable substitution):

  • {property_name} - The name of the property you want to create or replace
  • {property_type} - The type of the property you want to create or replace
  • {description_text} - Optional. The description of the property

Create or Update property

CREATE [OR REPLACE] PROPERTY `{property_name}` {property_type} DESCRIPTION '{description_text}';

Example:

CREATE [OR REPLACE] PROPERTY `city` STRING DESCRIPTION 'city name of customer';

Create or replace calculated property​

Create and edit calculated properties

In timbr calculated properties can reference both properties or other calculated properties.

Required information for creating or replacing a calculated property (the curly brackets {} should not be an input, they are used only as a variable substitution):

  • {property_name} - The name of the property you want to create or replace
  • {property_type} - The type of the property you want to create or replace
  • {description_text} - Optional. The description of the property
  • {calculation_or_transformation} - The calculation or transformation you want to apply on the property

Create or Update calculated property

CREATE [OR REPLACE] PROPERTY `{property_name}` {property_type} DESCRIPTION '{description_text}' AS SELECT {calculation_or_transformation};

Example:

-- base properties
CREATE [OR REPLACE] PROPERTY `first_name` string DESCRIPTION 'Customer first name';
CREATE [OR REPLACE] PROPERTY `last_name` string DESCRIPTION 'Customer last name';

-- calculated property:
CREATE [OR REPLACE] PROPERTY `full_name` string DESCRIPTION 'Customer full name' 
AS SELECT concat(first_name, ' ', last_name);

Example cleaning the calculated full_name:

CREATE [OR REPLACE] PROPERTY `full_name_clean` string
AS SELECT UPPER(TRIM(full_name));
Creating a calculated property over an existing property

Users can create calculated properties over existing properties by simply following the SQL template above of - CREATE OR REPLACE PROPERTY...

Add / Update a property description​

Add or update a property description

Required information for adding or updating a property description (the curly brackets {} should not be an input, they are used only as a variable substitution):

  • {property_name} - The name of the property you want to add the description to

  • {description_value} - The description value to be associated with the property

ALTER PROPERTY `{property_name}` SET DESCRIPTION = '{description_value}';
removing description

To remove a property description, use the same statement above for setting a property description, only this time set the description value with an empty string as follows: 

ALTER PROPERTY `{property_name}` SET DESCRIPTION = '';

Add / Update / Remove property tag​

Adding, updating, or removing a tag of a property

Required information for adding, updating, or removing a property tag (the curly brackets {} should not be an input, they are used only as a variable substitution):

  • {property_name} - The name of the property you want to add the tag to
  • {tag_name} - The tag key (name) to be added or updated to the property
  • {tag_value} - The tag value to be associated with the tag key of the property

Add / Update / Remove property options

ADD - This option is used to add a new tag to a property. If the tag already exists, the operation will fail. The syntax for adding a tag is:

ALTER PROPERTY `{property_name}` ADD TAG `{tag_name}` = '{tag_value}';

UPDATE - This option is used to update an existing tag or create it if it doesn't exist (effectively a 'create or replace' operation). This is useful for modifying tags without worrying about their prior existence. The syntax is:

ALTER PROPERTY `{property_name}` UPDATE TAG `{tag_name}` = '{tag_value}';

DROP - This option is for removing a tag from a property. The DROP operation has a slightly different syntax as it does not require a tag value:

ALTER PROPERTY `{property_name}` DROP TAG `{tag_name}`

Show SQL create property statement​

Required information for show create property (the curly brackets {} should not be an input, they are used only as a variable substitution):

  • {property_name} - The name of the property you want to show a create statement for. 
SHOW CREATE PROPERTY `{property_name}`

Rename a property​

Renames a property in the knowledge graph.

Required information for Renaming a property in the knowledge graph (the curly brackets {} should not be an input, they are used only as a variable substitution):

  • {current_name} - The current name of the property you want to rename
  • {new_name} - The new name you'd like to assign to the property
ALTER PROPERTY `{current_name}` rename to `{new_name}`;

Remove a property​

Removes a property from an ontology

Required information for removing a property from the ontology (the curly brackets {} should not be an input, they are used only as a variable substitution):

  • {property_name} - The name of the property you want to remove
DROP PROPERTY `{property_name}`;
Removing a property

It's important to notice that removing a property from the ontology model, will have the property removed from all instances and concepts it is assigned to.