Updated on 2025-09-18 GMT+08:00

DataArts Fabric DataFrame Connection Parameters

Use the ibis.fabric.connect interface to establish a connection. The following parameters can be passed:

Table 1 ibis.fabric.connect connection parameters

Parameter

Description

Type

Default Value

endpoint

Endpoint of a connection.

str | None

None

endpoint_id

Endpoint ID of a connection.

str | None

None

workspace_id

Workspace ID of a connection.

str | None

None

lakeformation_instance_id

LakeFormation service instance ID of a connection.

str | None

None

catalog_name

Catalog of the connection.

str | None

None

access_key

Access key ID of the connection.

str | None

None

secret_key

Access key of the connection.

str | None

None

security_token

Security token of the connection (required only when the access key ID and access key are temporary).

str | None

None

verify

Authentication of the connection.

bool

False

timeout

Timeout period of the connection.

float

fabric.options.requests_timeout

proxies

Proxy of the connection.

dict

fabric.options.proxies

concurrent_max_worker

Parallelism for downloading the OBS result set of a specified connection.

int

fabric.options.get_result_concurrent_max_worker

obs_server

OBS service address of the connection.

str | None

None

obs_bucket_name

OBS bucket name of the connection.

str | None

None

obs_directory_base

OBS root directory of the connection.

str | None

None

Use ibis.connect to connect (input the URL).

fabric://<your_access_key>:<your_secret_key>
@<your_endpoint>
?security_token=<your_security_token>
&endpoint_id=<your_endpoint_id>
&workspace_id=<your_workspace_id>
&lakeformation_instance_id=<your_lakeformation_instance_id>
&catalog_name=<your_catalog_name>
&verify=<your_verify>
&timeout=<your_timeout>
&proxies=<your_proxies>
&obs_server=<your_obs_server>
&obs_bucket_name=<your_obs_bucket_name>
&obs_directory_base=<your_obs_directory_base>

The parameters are the same as those of the ibis.fabric.connect interface.