TSC Datasource Management: All Methods

datasources.get — List & Filter Data Sources

List every datasource on your site and filter with RequestOptions + Filter (name, project, tags, owner, certification).

with server.auth.sign_in(tableau_auth):
    ro = TSC.RequestOptions()
    ro.filter.add(TSC.Filter(TSC.RequestOptions.Field.Name, TSC.RequestOptions.Operator.Contains, 'Sales'))
    all_datasources, pagination_item = server.datasources.get(ro)
    print([ds.name for ds in all_datasources])

datasources.get_by_id — Fetch a Specific Datasource

Each datasource has a unique ID; fetch it to access full details like project, owner, and certification note.

with server.auth.sign_in(tableau_auth):
    datasource = server.datasources.get_by_id('YOUR-DATASOURCE-ID')
    print(datasource.name, datasource.project_name, datasource.owner_id)

datasources.populate_connections — See Connection Details

Datasource objects do not include connection info by default. Populate to view server address, DB name, and connection type.

with server.auth.sign_in(tableau_auth):
    ds = server.datasources.get_by_id('YOUR-DATASOURCE-ID')
    server.datasources.populate_connections(ds)
    for conn in ds.connections:
        print(conn.connection_type, conn.server_address, conn.dbname)

datasources.download — Save a Datasource File

Download a local copy to inspect structure or keep a backup. You can exclude extracts for faster downloads.

with server.auth.sign_in(tableau_auth):
    path = server.datasources.download('YOUR-DATASOURCE-ID', include_extract=False)
    print(f'Downloaded to {path}')

datasources.publish — Publish a New Datasource

Publish a new datasource or update an existing one. Provide a valid file path and target project.

with server.auth.sign_in(tableau_auth):
    project_id = 'YOUR-PROJECT-ID'
    file_path = r'C:\\path\\to\\WorldIndicators.hyper'
    new_ds_item = TSC.DatasourceItem(project_id, name='WorldIndicators')
    new_ds = server.datasources.publish(new_ds_item, file_path, TSC.Server.PublishMode.CreateNew)
    print(new_ds.name, new_ds.id)

datasources.refresh — Run an On-Demand Extract Refresh

Trigger a refresh now instead of waiting for the schedule. Returns a job you can track.

with server.auth.sign_in(tableau_auth):
    ds = server.datasources.get_by_id('YOUR-DATASOURCE-ID')
    job = server.datasources.refresh(ds)
    print('Refresh job started:', job.id)

datasources.update — Update Metadata

Modify metadata like owner, description, and certification settings, then push changes.

with server.auth.sign_in(tableau_auth):
    ds = server.datasources.get_by_id('YOUR-DATASOURCE-ID')
    ds.certified = True
    ds.certification_note = 'Validated by BI team'
    updated = server.datasources.update(ds)
    print(updated.certified, updated.certification_note)

datasources.update_connection — Rotate or Edit Connection Credentials

Populate connections, change fields, then apply with update_connection.

with server.auth.sign_in(tableau_auth):
    ds = server.datasources.get_by_id('YOUR-DATASOURCE-ID')
    server.datasources.populate_connections(ds)
    conn = ds.connections[0]
    conn.server_address = 'new-db-host'
    conn.username = 'newuser'
    conn.password = 'newpass'
    updated_conn = server.datasources.update_connection(ds, conn)
    print(updated_conn.server_address, updated_conn.username)

datasources.update_hyper_data — Modify Rows in Live-to-Hyper Datasources

Push row-level updates into a published Hyper datasource (REST API 3.13+). Prepare a Hyper payload file with your changes.

# Example using pantab or Hyper API to build payload.hyper, then:
with server.auth.sign_in(tableau_auth):
    ds = server.datasources.get_by_id('YOUR-DATASOURCE-ID')
    actions = [{ 'action': 'insert', 'table': {'schema': 'public', 'name': 'region_sales'} }]
    job = server.datasources.update_hyper_data(ds, request_id='unique-req-001', actions=actions, payload='payload.hyper')
    print('Update job started:', job.id)

datasources.delete — Permanently Remove a Datasource

Deletes a datasource permanently. Double-check the ID before running this—there is no undo.

with server.auth.sign_in(tableau_auth):
    server.datasources.delete('YOUR-DATASOURCE-ID')
    print('Datasource deleted.')