Type 2 Add service to ConnectionItem properties For Oracle

Summary

Please include the Oracle Service Name in the ConnectionItems Attributes, similar to the functionality provided under: #1571

Description

Issue 1571 seems to have added the attribute database_name to the ConnectionItems Class, however it returns with 'none' when the connection_type is oracle

The following code
for i, conn in enumerate(datasource.connections, start=1):
for attr in dir(conn):
if not attr.startswith("_"):
value = getattr(conn, attr)
if not callable(value):
print(f"{attr}: {value}")

returns
auth_type: RDBMS
connection_credentials: None
connection_type: oracle
database_name: None
datasource_id: 12345678-90ab-cde1-2345-1234567890ab
datasource_name: Weekly data source
embed_password: False
id: 22345678-00ab-dde1-3345-2234567890ab
password: None
query_tagging: None
server_address: oracle.db.server
server_port: 1521
username: dbuser

Ideally I'd like the attribute 'service' added or for database_name to be dynamically populated with the relevant connection string attribute.
Mirroring the requirement specified in the previous issue we would like to be able to differentiate between connections to different databases on the same server, that share the same listener port.

Thanks for the report. Looked into this and the underlying issue turns out not to be Oracle-specific.

The REST API's <connection> response element has a fixed attribute set — currently id, type, authenticationType, dbClass, filename, googleSheetId, scope, useOAuthManagedKeychain, instanceUrl, oauthConfigId, embedPassword, password, serverAddress, serverPort, userName, queryTaggingEnabled, workgroupAuthMode, authFederationServiceAccount. There is no service, serviceName, dbName, or databaseName in what the server sends back on either GET /datasources/{id}/connections or GET /workbooks/{id}/connections, for any connection type. Verified by inspecting the API schema (v3.27–v3.30) and by round-tripping ~500 real connections across 10 connector types on Tableau Cloud — none of them carry those attributes. I will look into what should be added to this by the server. Tagging this as server-side work for now.

Follow-up to the last comment — the easiest way to read connector-specific attributes (Oracle service, Snowflake schema, Teradata query-band, initial SQL, etc.) today is the tableau/document-api-python library. Combined with TSC's datasources.download() or workbooks.download(), you can:

import tableauserverclient as TSC
from tableaudocumentapi import Datasource

server.datasources.download(ds_id, filepath="ds.tdsx", include_extract=False)
ds = Datasource.from_file("ds.tdsx")
for c in ds.connections:
    print(c.dbclass, c.server, c.dbname, c.service, c.schema, c.query_band, c.initial_sql)

That covers the connector-specific fields today. The REST API <connection> schema is a stripped subset of what's in the file itself.

Update — for the audit / discovery use case (finding which connections point at which Oracle services, dbnames, etc.), the Tableau Metadata API is a better fit than either the REST API or downloading files. The GraphQL DatabaseServer type exposes hostName, port, connectionType, and service — the last one being exactly the Oracle service name field this issue asks about.

feat(samples): sample for reading connector-specific connection attrs (…

Navigation Menu

Type 2 Add service to ConnectionItem properties For Oracle #1807

Summary

Description

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Type 2 Add service to ConnectionItem properties For Oracle #1807

Description

Summary

Description

Activity

jacalata commented on Jul 31, 2026

jacalata commented on Jul 31, 2026

jacalata commented on Jul 31, 2026

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions