Overview Use Cases Connectors Authentication Getting Started with the Python SDK API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors deleteDatabaseConnector getDatabaseConnectorObjectSchema listDatabaseConnectorObjects listDatabaseConnectors queryDatabaseConnector renameDatabaseConnector verifyDatabaseConnector dataset deployment deployment_conversations docstore document_retrievers documentation eda external_app feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard holdout_analysis llm_apps model model_monitoring module natural_language_explanation organization pipelines predict prediction_operator project python_function refresh secrets streaming streaming_connectors upload webhooks API Classes API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

Method

getDatabaseConnectorObjectSchema GET

Copy GET

Get the schema of an object in an database connector.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	databaseConnectorId	str	Unique string identifier for the database connector.
No	objectName	str	Unique identifier for the object in the external system.
No	fetchRawData	bool	If true, return unfiltered list of columns.

Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY

TYPE

DESCRIPTION

success

Boolean

true if the call succeeded, false if there was an error

result

DatabaseConnectorSchema

KEY

TYPE

Description

tableName

str

The unique name of the table.

columns

DatabaseConnectorColumn

List of columns in the table.

KEY	TYPE	Description
name	str	The unique name of the column.
externalDataType	str	The data type of column in the external database system.

Exceptions:

TYPE	WHEN
DataNotFoundError	`databaseConnectorId` is not found.

Language: