ConnectionDataSource

Defined in: js-api/src/data.ts:860

Represents data source, such as PostgreSQL, Oracle, S3, etc.

Constructors

Constructor

new ConnectionDataSource(dart): ConnectionDataSource

Defined in: js-api/src/data.ts:863

Parameters

Parameter	Type
dart	any

Returns

ConnectionDataSource

Properties

Property	Modifier	Type	Defined in
dart	public	any	js-api/src/data.ts:861

Accessors

canBrowseSchema

Get Signature

get canBrowseSchema(): boolean

Defined in: js-api/src/data.ts:923

Whether database schemas can be browsed from UI. Applicable only to database data sources.

Returns

boolean

---

category

Get Signature

get category(): string | undefined

Defined in: js-api/src/data.ts:885

Category (such as 'database').

Returns

string | undefined

---

commentStart

Get Signature

get commentStart(): string | undefined

Defined in: js-api/src/data.ts:909

Comment start, depends on SQL engine. Applicable only to database data sources.

Returns

string | undefined

---

connectionTemplate

Get Signature

get connectionTemplate(): Property[]

Defined in: js-api/src/data.ts:941

Returns

Property[]

---

credentialsTemplate

Get Signature

get credentialsTemplate(): Property[]

Defined in: js-api/src/data.ts:945

Returns

Property[]

---

description

Get Signature

get description(): string | undefined

Defined in: js-api/src/data.ts:892

Free-text description.

Returns

string | undefined

---

nameBrackets

Get Signature

get nameBrackets(): string | undefined

Defined in: js-api/src/data.ts:916

Name brackets, required if name contains spaces, depends on SQL engine. Applicable only to database data sources.

Returns

string | undefined

---

queryLanguage

Get Signature

get queryLanguage(): string | undefined

Defined in: js-api/src/data.ts:937

Applicable only to database data sources.

Returns

string | undefined

---

requiresServer

Get Signature

get requiresServer(): boolean

Defined in: js-api/src/data.ts:902

Indicates if this data provider can work right from the browser. When true, a query always executes on a server. Examples: Oracle, Postgres, MS SQL When false, a query runs on a server or in a browser, depending on the context (queries initiated from the browser would run in a browser).

Returns

boolean

---

supportCatalogs

Get Signature

get supportCatalogs(): boolean

Defined in: js-api/src/data.ts:930

Whether database catalogs can be browsed from UI. Applicable only to database data sources.

Returns

boolean

---

type

Get Signature

get type(): string

Defined in: js-api/src/data.ts:878

Data source name (such as 'Oracle'). DataConnection#dataSource refers to this value.

Returns

string

Methods

byType()

static byType(type): ConnectionDataSource | undefined

Defined in: js-api/src/data.ts:870

Use DataConnection#dataSource as input.

Parameters

Parameter	Type
type	string

Returns

ConnectionDataSource | undefined