# Data connectivity

> Data connectivity - Creates the connector from a jar file. Only available to admin users.

This Markdown file sits beside the HTML page at the same path (with a `.md` suffix). It summarizes the topic and lists links for tools and LLM context.

Companion generated at `2026-07-27T18:44:30.518041+00:00` (UTC).

## Primary page

- [Data connectivity](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md): Full documentation for this topic (Markdown sidecar).

## Sections on this page

- [DataDriver](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataDriver): In-page section heading.
- [list()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataDriver.list): In-page section heading.
- [get()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataDriver.get): In-page section heading.
- [create()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataDriver.create): In-page section heading.
- [update()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataDriver.update): In-page section heading.
- [delete()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataDriver.delete): In-page section heading.
- [Connector](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.Connector): In-page section heading.
- [list()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.Connector.list): In-page section heading.
- [get()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.Connector.get): In-page section heading.
- [create()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.Connector.create): In-page section heading.
- [delete()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.Connector.delete): In-page section heading.
- [DataStore](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore): In-page section heading.
- [list()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.list): In-page section heading.
- [get()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.get): In-page section heading.
- [create()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.create): In-page section heading.
- [update()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.update): In-page section heading.
- [delete()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.delete): In-page section heading.
- [test()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.test): In-page section heading.
- [schemas()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.schemas): In-page section heading.
- [tables()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.tables): In-page section heading.
- [from_server_data()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.from_server_data): In-page section heading.
- [get_shared_roles()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.get_shared_roles): In-page section heading.
- [share()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.share): In-page section heading.
- [DataSource](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource): In-page section heading.
- [list()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource.list): In-page section heading.
- [get()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource.get): In-page section heading.
- [create()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource.create): In-page section heading.
- [update()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource.update): In-page section heading.
- [delete()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource.delete): In-page section heading.
- [from_server_data()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource.from_server_data): In-page section heading.
- [get_access_list()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource.get_access_list): In-page section heading.
- [share()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource.share): In-page section heading.
- [create_dataset()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource.create_dataset): In-page section heading.
- [DataSourceParameters](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSourceParameters): In-page section heading.
- [JDBC data preview](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#jdbc-data-preview): In-page section heading.
- [JdbcPreview](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.JdbcPreview): In-page section heading.
- [preview()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.JdbcPreview.preview): In-page section heading.
- [JdbcPreviewData](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.JdbcPreviewData): In-page section heading.
- [JdbcResultSchemaEntry](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.JdbcResultSchemaEntry): In-page section heading.
- [Data store](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#data-store): In-page section heading.
- [TestResponse](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.models.data_store.TestResponse): In-page section heading.
- [SchemasResponse](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.models.data_store.SchemasResponse): In-page section heading.
- [TablesResponse](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.models.data_store.TablesResponse): In-page section heading.

## Documentation content

### DataDriver

A data driver

Variables

| Attribute | Type | Description |
| --- | --- | --- |
| id | str | the ID of the driver. |
| class_name | str | the Java class name for the driver. |
| canonical_name | str | the user-friendly name of the driver. |
| creator | str | the ID of the user who created the driver. |
| base_names | List[str] | a list of the file name(s) of the jar files. |

#### list()

Returns list of available drivers.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| typ | DataDriverListTypes | If specified, filters by specified driver type. |

Returns

| Returns | Description |
| --- | --- |
| drivers | contains a list of available drivers. |

Return type: [list](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataDriver.list) of `DataDriver instances`

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> drivers = dr.DataDriver.list()
> >>> drivers
> [DataDriver('mysql'), DataDriver('RedShift'), DataDriver('PostgreSQL')]
> ```

#### get()

Gets the driver.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| driver_id | str | the identifier of the driver. |

Returns

| Returns | Description |
| --- | --- |
| driver | the required driver. |

Return type: [DataDriver](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataDriver)

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> driver = dr.DataDriver.get('5ad08a1889453d0001ea7c5c')
> >>> driver
> DataDriver('PostgreSQL')
> ```

#### create()

Creates the driver. Only available to admin users.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| class_name | str | the Java class name for the driver. Specify None if typ is DataDriverTypes.DR_DATABASE_V1`. |
| canonical_name | str | the user-friendly name of the driver. |
| files | List[str] | a list of the file paths on file system file_path(s) for the driver. |
| typ | str | Optional. Specify the type of the driver. Defaults to DataDriverTypes.JDBC, may also be DataDriverTypes.DR_DATABASE_V1. |
| database_driver | str | Optional. Specify when typ is DataDriverTypes.DR_DATABASE_V1 to create a native database driver. See DrDatabaseV1Types enum for some of the types, but that list may not be exhaustive. |

Returns

| Returns | Description |
| --- | --- |
| driver | the created driver. |

Return type: [DataDriver](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataDriver)

Raises

| Exception | Description |
| --- | --- |
| ClientError | raised if user is not granted for Can manage JDBC database drivers feature |

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> driver = dr.DataDriver.create(
> ...     class_name='org.postgresql.Driver',
> ...     canonical_name='PostgreSQL',
> ...     files=['/tmp/postgresql-42.2.2.jar']
> ... )
> >>> driver
> DataDriver('PostgreSQL')
> ```

#### update()

Updates the driver. Only available to admin users.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| class_name | str | the Java class name for the driver. |
| canonical_name | str | the user-friendly name of the driver. |

Raises

| Exception | Description |
| --- | --- |
| ClientError | raised if user is not granted for Can manage JDBC database drivers feature |

Return type: `None`

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> driver = dr.DataDriver.get('5ad08a1889453d0001ea7c5c')
> >>> driver.canonical_name
> 'PostgreSQL'
> >>> driver.update(canonical_name='postgres')
> >>> driver.canonical_name
> 'postgres'
> ```

#### delete()

Removes the driver. Only available to admin users.

Raises

| Exception | Description |
| --- | --- |
| ClientError | raised if user is not granted for Can manage JDBC database drivers feature |

Return type: `None`

### Connector

A connector

Variables

| Attribute | Type | Description |
| --- | --- | --- |
| id | str | the ID of the connector. |
| creator_id | str | the ID of the user who created the connector. |
| base_name | str | the file name of the jar file. |
| canonical_name | str | the user-friendly name of the connector. |
| configuration_id | str | the ID of the configuration of the connector. |

#### list()

Returns list of available connectors.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| data_type | DataTypes | If specified, returns the connectors that support the specified data type. If not specified, it will default to DataTypes.ALL |

Returns

| Returns | Description |
| --- | --- |
| connectors | contains a list of available connectors. |

Return type: [list](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.Connector.list) of `Connector instances`

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> connectors = dr.Connector.list()
> >>> connectors
> [Connector('Google Drive'), Connector('S3')]
> ```

#### get()

Gets the connector.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| connector_id | str | the identifier of the connector. |

Returns

| Returns | Description |
| --- | --- |
| connector | the required connector. |

Return type: [Connector](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.Connector)

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> connector = dr.Connector.get('5fe1063e1c075e0245071446')
> >>> connector
> Connector('Google Drive')
> ```

#### create()

Creates the connector from a jar file. Only available to admin users.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| connector_type | str | The type of the native connector to create |

Returns

| Returns | Description |
| --- | --- |
| connector | the created connector. |

Return type: [Connector](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.Connector)

Raises

| Exception | Description |
| --- | --- |
| ClientError | raised if user is not granted for Can manage connectors feature |

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> connector = dr.Connector.create(connector_type='gdrive')
> >>> connector
> Connector('Google Drive')
> ```

#### delete()

Removes the connector. Only available to admin users.

Raises

| Exception | Description |
| --- | --- |
| ClientError | raised if user is not granted for Can manage connectors feature |

Return type: `None`

### DataStore

A data store. Represents database

Variables

| Attribute | Type | Description |
| --- | --- | --- |
| id | str | The id of the data store. |
| data_store_type | str | The type of data store. |
| canonical_name | str | The user-friendly name of the data store. |
| creator | str | The id of the user who created the data store. |
| updated | datetime.datetime | The time of the last update |
| params | DataStoreParameters | A list specifying data store parameters. |
| role | str | Your access role for this data store. |

#### list()

Returns list of available data stores.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| typ | str | If specified, filters by specified data store type. If not specified, the default is DataStoreListTypes.JDBC. |
| name | str | If specified, filters by data store names that match or contain this name. The search is case-insensitive. |
| substitute_url_parameters | bool | If specified, dynamic parameters in the URL will be substituted. |
| data_type | DataTypes | If specified, filters data stores which support the specified data type. If not specified it will default to DataTypes.ALL |

Returns

| Returns | Description |
| --- | --- |
| data_stores | contains a list of available data stores. |

Return type: [list](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.list) of `DataStore instances`

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> data_stores = dr.DataStore.list()
> >>> data_stores
> [DataStore('Demo'), DataStore('Airlines')]
> ```

#### get()

Gets the data store.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| data_store_id | str | the identifier of the data store. |
| substitute_url_parameters | bool | If specified, dynamic parameters in the URL will be substituted. |

Returns

| Returns | Description |
| --- | --- |
| data_store | the required data store. |

Return type: [DataStore](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore)

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> data_store = dr.DataStore.get('5a8ac90b07a57a0001be501e')
> >>> data_store
> DataStore('Demo')
> ```

#### create()

Creates the data store.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| data_store_type | str or DataStoreTypes | the type of data store. |
| canonical_name | str | the user-friendly name of the data store. |
| driver_id | str | Optional. The identifier of the DataDriver if data_store_type is DataStoreListTypes.JDBC or DataStoreListTypes.DR_DATABASE_V1. |
| jdbc_url | str | Optional. The full JDBC URL (for example: jdbc:postgresql://my.dbaddress.org:5432/my_db). |
| fields | list | Optional. If the type is dr-database-v1, then the fields specify the configuration. |
| connector_id | str | Optional. The identifier of the Connector if data_store_type is DataStoreListTypes.DR_CONNECTOR_V1 |

Returns

| Returns | Description |
| --- | --- |
| data_store | the created data store. |

Return type: [DataStore](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore)

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> data_store = dr.DataStore.create(
> ...     data_store_type='jdbc',
> ...     canonical_name='Demo DB',
> ...     driver_id='5a6af02eb15372000117c040',
> ...     jdbc_url='jdbc:postgresql://my.db.address.org:5432/perftest'
> ... )
> >>> data_store
> DataStore('Demo DB')
> ```

#### update()

Updates the data store.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| canonical_name | str | Optional; the user-friendly name of the data store. |
| driver_id | str | Optional. The identifier of the DataDriver. if the type is one of DataStoreTypes.DR_DATABASE_V1 or DataStoreTypes.JDBC. |
| connector_id | str | Optional. The identifier of the Connector. if the type is DataStoreTypes.DR_CONNECTOR_V1. |
| jdbc_url | str | Optional. The full JDBC URL (for example: jdbc:postgresql://my.dbaddress.org:5432/my_db). |
| fields | list | Optional. If the type is dr-database-v1, then the fields specify the configuration. |

Return type: `None`

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> data_store = dr.DataStore.get('5ad5d2afef5cd700014d3cae')
> >>> data_store
> DataStore('Demo DB')
> >>> data_store.update(canonical_name='Demo DB updated')
> >>> data_store
> DataStore('Demo DB updated')
> ```

#### delete()

Removes the DataStore

Return type: `None`

#### test()

Tests database connection.

Changed in version v3.2: Added credential_id, use_kerberos and credential_data optional params and made
username and password optional.

Changed in version v3.9: If credential_id is provided and set_default_credential is True and the connection test is successful,
the credential is set as the default for this data store.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| username | str | Optional; the username for database authentication. |
| password | str | Optional; the password for database authentication. The password is encrypted at server side and never saved / stored |
| credential_id | str | optional, id of the set of credentials to use instead of username and password |
| use_kerberos | bool | Optional; whether to use Kerberos for data store authentication |
| credential_data | dict | Optional; the credentials to authenticate with the database, to use instead of user/password or credential ID |
| set_default_credential | bool | optional, if True and credential_id is provided, sets the credential as default for this data store Default is False. |

Returns

| Returns | Description |
| --- | --- |
| message | message with status. |

Return type: `dict`

Raises

| Exception | Description |
| --- | --- |
| CredentialsError | If unable to set the provided credential_id as default for this data store. |

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> data_store = dr.DataStore.get('5ad5d2afef5cd700014d3cae')
> >>> data_store.test(username='db_username', password='db_password')
> {'message': 'Connection successful'}
> ```

#### schemas()

Returns list of available schemas.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| username | str | the username for database authentication. |
| password | str | the password for database authentication. The password is encrypted at server side and never saved / stored |

Returns

| Returns | Description |
| --- | --- |
| response | dict with database name and list of str - available schemas |

Return type: `dict`

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> data_store = dr.DataStore.get('5ad5d2afef5cd700014d3cae')
> >>> data_store.schemas(username='db_username', password='db_password')
> {'catalog': 'perftest', 'schemas': ['demo', 'information_schema', 'public']}
> ```

#### tables()

Returns list of available tables in schema.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| username | str | Optional; the username for database authentication. |
| password | str | Optional; the password for database authentication. The password is encrypted at server side and never saved / stored |
| schema | str | Optional; the schema name. |

Returns

| Returns | Description |
| --- | --- |
| response | dict with catalog name and tables info |

Return type: `dict`

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> data_store = dr.DataStore.get('5ad5d2afef5cd700014d3cae')
> >>> data_store.tables(username='db_username', password='db_password', schema='demo')
> {'tables': [{'type': 'TABLE', 'name': 'diagnosis', 'schema': 'demo'}, {'type': 'TABLE',
> 'name': 'kickcars', 'schema': 'demo'}, {'type': 'TABLE', 'name': 'patient',
> 'schema': 'demo'}, {'type': 'TABLE', 'name': 'transcript', 'schema': 'demo'}],
> 'catalog': 'perftest'}
> ```

#### from_server_data()

Instantiate an object of this class using the data directly from the server,
meaning that the keys may have the wrong camel casing

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| data | dict | The directly translated dict of JSON from the server. No casing fixes have taken place |
| keep_attrs | iterable | List, set or tuple of the dotted namespace notations for attributes to keep within the object structure even if their values are None |

Return type: [DataStore](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore)

#### get_shared_roles()

Retrieve what users have access to this data store

Added in version v3.2.

Return type: [list](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataStore.list) of [SharingRole](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-registry.html.md#datarobot.models.sharing.SharingRole)

#### share()

Modify the ability of users to access this data store

Added in version v2.14.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| access_list | list of SharingRole | the modifications to make. |

Return type: `None`

Raises

| Exception | Description |
| --- | --- |
| datarobot.ClientError : | if you do not have permission to share this data store, if the user you’re sharing with doesn’t exist, if the same user appears multiple times in the access_list, or if these changes would leave the data store without an owner. |

> [!NOTE] Examples
> The [SharingRole](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-registry.html.md#datarobot.models.sharing.SharingRole) class is needed in order to
> share a Data Store with one or more users.
> 
> For example, suppose you had a list of user IDs you wanted to share this DataStore with. You could use
> a loop to generate a list of [SharingRole](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-registry.html.md#datarobot.models.sharing.SharingRole) objects for them,
> and bulk share this Data Store.
> 
> ```
> >>> import datarobot as dr
> >>> from datarobot.models.sharing import SharingRole
> >>> from datarobot.enums import SHARING_ROLE, SHARING_RECIPIENT_TYPE
> >>>
> >>> user_ids = ["60912e09fd1f04e832a575c1", "639ce542862e9b1b1bfa8f1b", "63e185e7cd3a5f8e190c6393"]
> >>> sharing_roles = []
> >>> for user_id in user_ids:
> ...     new_sharing_role = SharingRole(
> ...         role=SHARING_ROLE.CONSUMER,
> ...         share_recipient_type=SHARING_RECIPIENT_TYPE.USER,
> ...         id=user_id,
> ...         can_share=True,
> ...     )
> ...     sharing_roles.append(new_sharing_role)
> >>> dr.DataStore.get('my-data-store-id').share(access_list)
> ```
> 
> Similarly, a [SharingRole](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-registry.html.md#datarobot.models.sharing.SharingRole) instance can be used to
> remove a user’s access if the `role` is set to `SHARING_ROLE.NO_ROLE`, like in this example:
> 
> ```
> >>> import datarobot as dr
> >>> from datarobot.models.sharing import SharingRole
> >>> from datarobot.enums import SHARING_ROLE, SHARING_RECIPIENT_TYPE
> >>>
> >>> user_to_remove = "foo.bar@datarobot.com"
> ... remove_sharing_role = SharingRole(
> ...     role=SHARING_ROLE.NO_ROLE,
> ...     share_recipient_type=SHARING_RECIPIENT_TYPE.USER,
> ...     username=user_to_remove,
> ...     can_share=False,
> ... )
> >>> dr.DataStore.get('my-data-store-id').share(roles=[remove_sharing_role])
> ```

### DataSource

A data source. Represents data request

Variables

| Attribute | Type | Description |
| --- | --- | --- |
| id | str | the ID of the data source. |
| type | str | the type of data source. |
| canonical_name | str | the user-friendly name of the data source. |
| creator | str | the ID of the user who created the data source. |
| updated | datetime.datetime | the time of the last update. |
| params | DataSourceParameters | a list specifying data source parameters. |
| role | str or None | if a string, represents a particular level of access and should be one of datarobot.enums.SHARING_ROLE. For more information on the specific access levels, see the sharing documentation. If None, can be passed to a share function to revoke access for a specific user. |

#### list()

Returns list of available data sources.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| typ | DataStoreListTypes | If specified, filters by specified datasource type. If not specified it will default to DataStoreListTypes.DATABASES |

Returns

| Returns | Description |
| --- | --- |
| data_sources | contains a list of available data sources. |

Return type: [list](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource.list) of `DataSource instances`

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> data_sources = dr.DataSource.list()
> >>> data_sources
> [DataSource('Diagnostics'), DataSource('Airlines 100mb'), DataSource('Airlines 10mb')]
> ```

#### get()

Gets the data source.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| data_source_id | str | the identifier of the data source. |

Returns

| Returns | Description |
| --- | --- |
| data_source | the requested data source. |

Return type: [DataSource](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource)

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> data_source = dr.DataSource.get('5a8ac9ab07a57a0001be501f')
> >>> data_source
> DataSource('Diagnostics')
> ```

#### create()

Creates the data source.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| data_source_type | str or DataStoreTypes | the type of data source. |
| canonical_name | str | the user-friendly name of the data source. |
| params | DataSourceParameters | a list specifying data source parameters. |

Returns

| Returns | Description |
| --- | --- |
| data_source | the created data source. |

Return type: [DataSource](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource)

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> params = dr.DataSourceParameters(
> ...     data_store_id='5a8ac90b07a57a0001be501e',
> ...     query='SELECT * FROM airlines10mb WHERE "Year" >= 1995;'
> ... )
> >>> data_source = dr.DataSource.create(
> ...     data_source_type='jdbc',
> ...     canonical_name='airlines stats after 1995',
> ...     params=params
> ... )
> >>> data_source
> DataSource('airlines stats after 1995')
> ```

#### update()

Creates the data source.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| canonical_name | str | Optional; the user-friendly name of the data source. |
| params | DataSourceParameters | Optional; the identifier of the DataDriver. |

Return type: `None`

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> data_source = dr.DataSource.get('5ad840cc613b480001570953')
> >>> data_source
> DataSource('airlines stats after 1995')
> >>> params = dr.DataSourceParameters(
> ...     query='SELECT * FROM airlines10mb WHERE "Year" >= 1990;'
> ... )
> >>> data_source.update(
> ...     canonical_name='airlines stats after 1990',
> ...     params=params
> ... )
> >>> data_source
> DataSource('airlines stats after 1990')
> ```

#### delete()

Removes the DataSource

Return type: `None`

#### from_server_data()

Instantiate an object of this class using the data directly from the server,
meaning that the keys may have the wrong camel casing

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| data | dict | The directly translated dict of JSON from the server. No casing fixes have taken place |
| keep_attrs | iterable | List, set or tuple of the dotted namespace notations for attributes to keep within the object structure even if their values are None |

Return type: `TypeVar` ( `TDataSource`, bound= DataSource)

#### get_access_list()

Retrieve what users have access to this data source

Added in version v2.14.

Return type: [list](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.DataSource.list) of [SharingAccess](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-registry.html.md#datarobot.SharingAccess)

#### share()

Modify the ability of users to access this data source

Added in version v2.14.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| access_list | list of SharingAccess | The modifications to make. |

Return type: `None`

Raises

| Exception | Description |
| --- | --- |
| datarobot.ClientError: | If you do not have permission to share this data source, if the user you’re sharing with doesn’t exist, if the same user appears multiple times in the access_list, or if these changes would leave the data source without an owner. |

> [!NOTE] Examples
> Transfer access to the data source from [old_user@datarobot.com](mailto:old_user@datarobot.com) to [new_user@datarobot.com](mailto:new_user@datarobot.com)
> 
> ```
> from datarobot.enums import SHARING_ROLE
> from datarobot.models.data_source import DataSource
> from datarobot.models.sharing import SharingAccess
> 
> new_access = SharingAccess(
>     "new_user@datarobot.com",
>     SHARING_ROLE.OWNER,
>     can_share=True,
> )
> access_list = [
>     SharingAccess("old_user@datarobot.com", SHARING_ROLE.OWNER, can_share=True),
>     new_access,
> ]
> 
> DataSource.get('my-data-source-id').share(access_list)
> ```

#### create_dataset()

Create a [Dataset](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-registry.html.md#datarobot.models.Dataset) from this data source.

Added in version v2.22.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| username | string, optional | The username for database authentication. |
| password | string, optional | The password (in cleartext) for database authentication. The password will be encrypted on the server side in scope of HTTP request and never saved or stored. |
| do_snapshot | Optional[bool] | If unset, uses the server default: True. If true, creates a snapshot dataset; if false, creates a remote dataset. Creating snapshots from non-file sources requires an additional permission, Enable Create Snapshot Data Source. |
| persist_data_after_ingestion | Optional[bool] | If unset, uses the server default: True. If true, will enforce saving all data (for download and sampling) and will allow a user to view extended data profile (which includes data statistics like min/max/median/mean, histogram, etc.). If false, will not enforce saving data. The data schema (feature names and types) still will be available. Specifying this parameter to false and doSnapshot to true will result in an error. |
| categories | list[string], optional | An array of strings describing the intended use of the dataset. The current supported options are “TRAINING” and “PREDICTION”. |
| credential_id | string, optional | The ID of the set of credentials to use instead of user and password. Note that with this change, username and password will become optional. |
| use_kerberos | Optional[bool] | If unset, uses the server default: False. If true, use kerberos authentication for database authentication. |

Returns

| Returns | Description |
| --- | --- |
| response | The Dataset created from the uploaded data |

Return type: `Dataset`

### DataSourceParameters

Data request configuration

Variables

| Attribute | Type | Description |
| --- | --- | --- |
| data_store_id | str | the ID of the DataStore. |
| table | str | Optional. The name of specified database table. |
| schema | str | Optional. The name of the schema associated with the table. |
| partition_column | str | Optional. The name of the partition column. |
| query | str | Optional. The user specified SQL query. |
| fetch_size | int | Optional. A user specified fetch size in the range [1, 20000]. By default a fetchSize will be assigned to balance throughput and memory usage |
| path | str | Optional. The user-specified path for BLOB storage |
| filter | str | A connector-specific filter string (e.g., JQL for Jira). Only supported for DataRobot Connector v1, where applicable. (optional) |

## JDBC data preview

Preview data from a JDBC URL by executing SQL without creating a data store.

### JdbcPreview

JDBC data preview API: run SQL against a JDBC URL and get a row-limited preview
without creating a data store.

Entry-point class with [preview()](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.JdbcPreview.preview) returning a [JdbcPreviewData](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.JdbcPreviewData).

#### preview()

Preview data from a JDBC URL by executing SQL without creating a data store.

Executes the given SQL against the JDBC URL and returns a row-limited preview.
Connection credentials and parameters may be specified in the JDBC URL and/or
in the `parameters` dict (e.g.`user`, `password`, `ssl`, `timeout`).

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| jdbc_url | str | The JDBC URL (e.g. jdbc:postgresql://host:5432/dbname). |
| sql | str | The SQL to execute (e.g. SELECT * FROM my_table LIMIT 10). |
| max_rows | int, optional | Row limit for the preview. Default is 1,000; maximum is 10,000. |
| parameters | dict, optional | Optional connection parameters and credentials as key-value pairs (e.g. {"user": "u", "password": "p"}). |

Returns

| Returns | Description |
| --- | --- |
| Object with columns (list of column names), records (list of rows), |  |
| and result_schema (list of JdbcResultSchemaEntry), if returned by the server. |  |

Return type: [JdbcPreviewData](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.JdbcPreviewData)

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> preview = dr.JdbcPreview.preview(
> ...     jdbc_url='jdbc:postgresql://localhost:5432/mydb',
> ...     sql='SELECT * FROM public.users',
> ...     max_rows=5,
> ...     parameters={'user': 'dbuser', 'password': 'secret'},
> ... )
> >>> preview.columns
> ['id', 'name', 'email']
> >>> len(preview.records)
> 5
> ```

### JdbcPreviewData

A JDBC data preview: columns, records, and optional result schema from running
SQL against a JDBC URL.

### JdbcResultSchemaEntry

Column metadata for one column in a JDBC data preview result schema.

Returned as elements of the `result_schema` attribute of [JdbcPreviewData](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.JdbcPreviewData). Built via
validation in [JdbcPreviewData](https://docs.datarobot.com/ja/docs/api/reference/sdk/data-connectivity.html.md#datarobot.JdbcPreviewData).

Variables

| Attribute | Type | Description |
| --- | --- | --- |
| name | str | Column name. |
| data_type | str | SQL/data type name (e.g. INTEGER, VARCHAR). |
| precision | int or None | Optional numeric precision. |
| scale | int or None | Optional numeric scale. |
| data_type_int | int or None | Optional integer code for the data type. |

## Data store

### TestResponse

### SchemasResponse

### TablesResponse