DataConnectionProperties

Defined in: js-api/src/entities/types.ts:73

Represents data connection properties.

The available properties depend on the DataSourceType. Common properties are defined explicitly, but each connector may support additional parameters.

For a complete list of supported parameters:

• Database connectors: https://datagrok.ai/help/access/databases/connectors/
• File shares: https://datagrok.ai/help/access/files/shares/

Examples

// PostgreSQL connection
const props: DataConnectionProperties = {
  dataSource: 'Postgres',
  server: 'localhost',
  port: 5432,
  db: 'mydb',
  login: 'user',
  password: 'pass'
};

// S3 file share
const props: DataConnectionProperties = {
  dataSource: 'S3',
  accessKey: 'AKIA...',
  secretKey: '...',
  region: 'us-east-1',  // connector-specific parameter
  bucket: 'my-bucket'   // connector-specific parameter
};

Extends

• DatabaseConnectionProperties.DataConnectionCacheProperties

Indexable

[x: string]: string | number | boolean | undefined

Additional connector-specific parameters. The available parameters vary by dataSource type.

Properties

Property	Type	Description	Inherited from	Defined in
accessKey?	string	AWS access key (for AWS-based connectors)	-	js-api/src/entities/types.ts:81
cacheInvalidateSchedule?	string	Cron expression for cache invalidation schedule	DataConnectionCacheProperties.cacheInvalidateSchedule	js-api/src/entities/types.ts:39
cacheResults?	boolean	Whether to cache query results	DataConnectionCacheProperties.cacheResults	js-api/src/entities/types.ts:35
cacheSchema?	boolean	Whether to cache database schema information	DataConnectionCacheProperties.cacheSchema	js-api/src/entities/types.ts:37
connString?	string	Full connection string (alternative to individual parameters)	DatabaseConnectionProperties.connString	js-api/src/entities/types.ts:26
dataSource	string	Data source type identifier (e.g., 'Postgres', 'MySQL', 'S3', 'Git')	-	js-api/src/entities/types.ts:75
db?	string	Database name	DatabaseConnectionProperties.db	js-api/src/entities/types.ts:24
login?	string	Login/username for authentication	-	js-api/src/entities/types.ts:77
password?	string	Password for authentication	-	js-api/src/entities/types.ts:79
port?	number	Database server port number	DatabaseConnectionProperties.port	js-api/src/entities/types.ts:22
region?	string	AWS region (for AWS-based connectors like S3, Athena)	-	js-api/src/entities/types.ts:85
secretKey?	string	AWS secret key (for AWS-based connectors)	-	js-api/src/entities/types.ts:83
server?	string	Database server hostname or IP address	DatabaseConnectionProperties.server	js-api/src/entities/types.ts:20
ssl?	string | boolean	SSL/TLS mode (for database connectors)	-	js-api/src/entities/types.ts:87