Interface IGetDataSource

interface IGetDataSource {
    containerPath?: string;
    queryName?: string;
    schemaName?: string | string[] | SchemaKey;
    sql?: string;
    type?: "sql" | "query";
}

Properties

containerPath? queryName? schemaName? sql? type?

Properties

Optional containerPath

containerPath?: string

The path to the target container to execute the GetData call in.

Optional queryName

queryName?: string

The queryName to use in the request. Required if source.type = "query".

Optional schemaName

schemaName?: string | string[] | SchemaKey

The schemaName to use in the request. Can be a string, array of strings, or SchemaKey.

Optional sql

sql?: string

The LabKey SQL to use in the request. Required if source.type = "sql".

Optional type

type?: "sql" | "query"

A string with value set to either "query" or "sql". Indicates if the value is "sql" then source.sql is required. If the value is "query" then source.queryName is required.

Settings

Member Visibility

Theme

On This Page

containerPathqueryNameschemaNamesqltype

Generated using TypeDoc