ConnectionDataSource

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

Constructors

new ConnectionDataSource()

new ConnectionDataSource(dart): ConnectionDataSource

Parameters

Parameter	Type
dart	any

Returns

ConnectionDataSource

Source

src/data.ts:719

Properties

Property	Modifier	Type
dart	public	any

Accessors

canBrowseSchema

get canBrowseSchema(): boolean

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

Returns

boolean

Source

src/data.ts:779

---

category

get category(): undefined | string

Category (such as 'database').

Returns

undefined | string

Source

src/data.ts:741

---

commentStart

get commentStart(): undefined | string

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

Returns

undefined | string

Source

src/data.ts:765

---

connectionTemplate

get connectionTemplate(): Property[]

Returns

Property[]

Source

src/data.ts:797

---

credentialsTemplate

get credentialsTemplate(): Property[]

Returns

Property[]

Source

src/data.ts:801

---

description

get description(): undefined | string

Free-text description.

Returns

undefined | string

Source

src/data.ts:748

---

nameBrackets

get nameBrackets(): undefined | string

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

Returns

undefined | string

Source

src/data.ts:772

---

queryLanguage

get queryLanguage(): undefined | string

Applicable only to database data sources.

Returns

undefined | string

Source

src/data.ts:793

---

requiresServer

get requiresServer(): boolean

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

Source

src/data.ts:758

---

supportCatalogs

get supportCatalogs(): boolean

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

Returns

boolean

Source

src/data.ts:786

---

type

get type(): string

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

Returns

string

Source

src/data.ts:734

Methods

byType()

static byType(type): undefined | ConnectionDataSource

Use DataConnection#dataSource as input.

Parameters

Parameter	Type
type	string

Returns

undefined | ConnectionDataSource

Source

src/data.ts:726