Skip to main content

SQL Syntax Documentation

Changes in this section should only be made by experienced users.

The JSON file in this section describes the tooltips that appear when an SQL script is created within the Asset Manager. The configuration file is located here:

C:\Users\<Current User>\AppData\Local\smcTeam\AssetManager\4\SqlDoc.json

To prevent the file’s contents from being accidentally modified, it is initially protected against editing:

am-locked-editor.png

Only after clicking the lock icon are all icons activated (and can also be deactivated again):

am-unlocked-editor.png

The data in the SqlDoc.json file consists of an array:

[
	{
		"Key": "ABS",
		"Description": "A mathematical function that returns the absolute (positive) value of the specified numeric expression. ('ABS' changes negative values to positive values. 'ABS' has no effect on zero or positive values.)",
		"Syntax": "ABS ( numeric_expression )",
		"SqlDocumentType": 1,
		"SqlLanguageType": 1
	},
    {
      ...
    }
]

Each array consists of the following elements:

  • Key: The keyword for which the tooltip should be displayed.
  • Description: The description of the function, operator, data type, etc.
  • Syntax: Description of the syntax.
  • SqlDocumentType:  DataType = 0, Function = 1, LanguageElement = 2, Missing = 4, Query = 8.
  • SqlLanguageType: DataType = 0, Function = 1, Keyword = 2, LogicalOperator = 4, Operator = 8.


Deleting the SqlDoc.json file resets the settings for SQL syntax documentation to their default values after a restart.

Back to top