User-defined System Properties Management

You are looking at an older version of the documentation. The latest version is found here.

User-defined system properties are managed via special procedures described on this page. The two most important things about them are that they are stored per VDB and not available from other VDBs, and that they are readable by all users within a VDB and editable and deletable only by its creator or the administrator.

SYSADMIN.addSystemProperty

This procedure adds a new system property:

SQL

CREATE FOREIGN PROCEDURE addSystemProperty(IN propType string NOT NULL, IN propKey string NOT NULL, IN properties string NOT NULL, OUT id biginteger NOT NULL RESULT)

It takes the following mandatory parameters:

Parameter	Description
`propType`	Type of system property, can be an empty string
`propKey`	System property key, unique within a VDB
`properties`	System property string, can be an empty string or hold a string with spaces and/or special characters

It returns the newly created property's ID, which can be used in other procedures described on this page.

Example

SQL

CALL "SYSADMIN.addSystemProperty"(
    "propType" => 'string_propType',
    "propKey" => 'string_propKey',
    "properties" => 'string_properties'
);;

SYSADMIN.editSystemProperty

This procedure edits an existing system property by ID:

SQL

CREATE FOREIGN PROCEDURE editSystemProperty(IN id biginteger NOT NULL, IN propType string NOT NULL, IN propKey string NOT NULL, IN properties string NOT NULL)

It takes the following mandatory parameters:

Parameter	Description
`id`	Unique property id
`propType`	Type of system property, can be an empty string
`propKey`	System property key, unique within a VDB
`properties`	System property string, can be an empty string or hold a string with spaces and/or special characters

Example

SQL

CALL "SYSADMIN.editSystemProperty"(
    "id" => biginteger_id,
    "propType" => 'string_propType',
    "propKey" => 'string_propKey',
    "properties" => 'string_properties'
);;

Please note that a system property can be edited only by its creator or the administrator.

SYSADMIN.deleteSystemProperty

This procedure deletes an existing system property by ID:

SQL

CREATE FOREIGN PROCEDURE deleteSystemProperty(IN id biginteger NOT NULL)

It takes a single mandatory parameter: id, the unique property id.

Example

SQL

 CALL "SYSADMIN.deleteSystemProperty"("id" => biginteger_id);;

Please note that a system property can be deleted only by its creator or the administrator.