CONFIG_AUTOCOMPLETIONS

CONFIG_AUTOCOMPLETIONS is a configuration package that is used to configure custom autocompletions for the built-in code editor.

See also:

• Configuration packages

• Load steps

Usage

1. Open the configuration package from Designer Package list.

2. Click CONFIGURATION and Edit to edit the package with the built-in editor

OR

2. Click Export package in the Actions tab.

3. Click Download.

4. Edit the JSON file.

5. Import the edited JSON back to Designer with Import Package.

Finally, commit the changes to store a version of the configuration package.

Autocompletion in the code editor

The code editor appears when editing load steps or configuration packages. It is based on the Monaco Editor and supports autocompletion.

To use autocompletion within the code editor, start typing code, press Control + Space and the autocompletion menu appears:

Suggestions are made based on the context, including:

• Schema and entity names

• Attribute names of source and target entities

• Variable and environment variable names

• Keywords previously used in the code

• Custom autocompletions configured in the CONFIG_AUTOCOMPLETIONS configuration package

The autocompletion menu gives additional information about the suggestion type with an icon and a description.

Contents

Autocompletions

Autocompletion configurations are managed inside a JSON array block named autocompletions.

Key	Value type	Example	Description
autocompletionId	String	65a61283-801f-4d89-9c8f-19607682b016	Unique identifier
enabled	Boolean	true	True/false, enables or disables the autocompletion.
language	String	SQL	Code language, SQL and JSON allowed.
type	String	KEYWORD	Allowed values: UNIT CLASS FIELD VARIABLE KEYWORD SNIPPET Default: KEYWORD
labelText	String	LATERAL FLATTEN	Label text (name) for the autocompletion shown in the menu.
insertText	String	LATERAL FLATTEN	Code inserted when autocompletion suggestion is selected.
filterText	String	LATERAL FLATTEN	Used for filtering the autocompletion suggestions in the menu.
sortText	String	LATERAL FLATTEN	Used for sorting the autocompletion suggestions in the menu.
detailText	String	Lateral flatten keyword	Detailed description for the autocompletion shown in the menu.

Examples

Autocompletion for a user-defined function (UDF)

In this example we will configure autocompletion for calling a user-defined function (UDF) within an SQL load step. We will use autocompletion type SNIPPET which allows defining placeholders for UDF arguments.

Example configuration:

"autocompletions": [
    {
        "autocompletionId": "21d802ba-849e-4561-b904-7f643ccc99a1",
        "enabled": true,
        "language": "SQL",
        "type": "SNIPPET",
        "labelText": "my_udf(x integer, y string)",
        "insertText": "my_udf(${1:x}.${2:y})",
        "filterText": "my_udf",
        "sortText": "my_udf",
        "detailText": "Call function my_udf"
    }
]

After configuring the autocompletion, it can be used in the code editor. Start typing and press Control + Space:

Select the suggested autocompletion and the code is inserted with the configured placeholders activated:

Enter a value for the first argument and move to the next one by pressing Tab.