databricks-sql-python の API リファレンス

databricks-sql-python (databricks/databricks-sql-python) の公開 API 129 件 —— クラス 73、関数 3、メソッド 53。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: databricks/databricks-sql-python

種別	件数
クラス	73
関数	3
メソッド	53

API 一覧

funcsrc.databricks.sql.auth.auth_utils.decode_token(access_token:str) -> Optional[Dict]

Decode a JWT token without verification to extract claims.

funcsrc.databricks.sql.auth.auth_utils.is_same_host(url1:str, url2:str) -> bool

Check if two URLs have the same host.

classsrc.databricks.sql.auth.oauth.Token

A class to represent a token.

methodsrc.databricks.sql.auth.token_federation.Token.is_expired() -> bool

Check if the token is expired.

methodsrc.databricks.sql.auth.token_federation.Token.to_dict() -> Dict[str, str]

Convert token to dictionary format.

classsrc.databricks.sql.backend.kernel.result_set.KernelResultSet

Streaming ``ResultSet`` over a kernel handle.

classsrc.databricks.sql.backend.sea.models.base.ChunkInfo

Information about a chunk in the result set.

classsrc.databricks.sql.backend.sea.models.base.ExternalLink

External link information for result data.

classsrc.databricks.sql.backend.sea.models.base.ResultData

Result data from a statement execution.

classsrc.databricks.sql.backend.sea.models.base.ResultManifest

Manifest information for a result set.

classsrc.databricks.sql.backend.sea.models.base.ServiceError

Error information returned by the SEA API.

classsrc.databricks.sql.backend.sea.models.base.StatementStatus

Status information for a statement execution.

classsrc.databricks.sql.backend.sea.queue.JsonQueue

Queue implementation for JSON_ARRAY format data.

methodsrc.databricks.sql.backend.sea.queue.JsonQueue.next_n_rows(num_rows:int) -> List[List[str]]

Get the next n rows from the data array.

methodsrc.databricks.sql.backend.sea.queue.JsonQueue.remaining_rows() -> List[List[str]]

Get all remaining rows from the data array.

classsrc.databricks.sql.backend.sea.result_set.SeaResultSet

ResultSet implementation for SEA backend.

methodsrc.databricks.sql.backend.sea.result_set.SeaResultSet.fetchmany_arrow(size:int) -> 'pyarrow.Table'

Fetch the next set of rows as an Arrow table.

methodsrc.databricks.sql.backend.sea.result_set.SeaResultSet.fetchmany_json(size:int) -> List[List[str]]

Fetch the next set of rows as a columnar table.

classsrc.databricks.sql.backend.sea.utils.constants.MetadataCommands

SQL commands used in the SEA backend.

classsrc.databricks.sql.backend.sea.utils.constants.ResultCompression

Enum for result compression values.

classsrc.databricks.sql.backend.sea.utils.constants.ResultDisposition

Enum for result disposition values.

classsrc.databricks.sql.backend.sea.utils.constants.ResultFormat

Enum for result format values.

classsrc.databricks.sql.backend.sea.utils.constants.WaitTimeout

Enum for wait timeout values.

classsrc.databricks.sql.backend.sea.utils.filters.ResultSetFilter

A general-purpose filter for result sets.

methodsrc.databricks.sql.backend.sea.utils.http_client.SeaHttpClient.using_proxy() -> bool

Check if proxy is being used.

classsrc.databricks.sql.backend.types.BackendType

Enum representing the type of backend

methodsrc.databricks.sql.backend.types.CommandState.from_sea_state(state:str) -> Optional['CommandState']

Map SEA state string to CommandState enum.

classsrc.databricks.sql.backend.types.ExecuteResponse

Response from executing a SQL command.

methodsrc.databricks.sql.client.Connection.autocommit() -> bool

Get auto-commit mode for this connection.

methodsrc.databricks.sql.client.Connection.commit() -> None

Commit the current transaction.

methodsrc.databricks.sql.client.Connection.get_session_id_hex()

Get the session ID in hex format

methodsrc.databricks.sql.client.Connection.get_transaction_isolation() -> str

Get the transaction isolation level.

methodsrc.databricks.sql.client.Connection.rollback() -> None

Rollback the current transaction.

methodsrc.databricks.sql.client.Connection.set_transaction_isolation(level:str) -> None

Set transaction isolation level.

methodsrc.databricks.sql.client.Cursor.cancel() -> None

Cancel a running command.

methodsrc.databricks.sql.client.Cursor.catalogs() -> 'Cursor'

Get all available catalogs.

methodsrc.databricks.sql.client.Cursor.close() -> None

Close cursor

methodsrc.databricks.sql.client.Cursor.setinputsizes(sizes)

Does nothing by default

methodsrc.databricks.sql.client.Cursor.setoutputsize(size, column=None)

Does nothing by default

classsrc.databricks.sql.cloudfetch.downloader.DownloadedFile

Class for the result file and metadata.

classsrc.databricks.sql.exc.CursorAlreadyClosedError

Thrown if CancelOperation receives a code 404.

classsrc.databricks.sql.exc.Error

Base class for DB-API2.0 exceptions.

classsrc.databricks.sql.exc.NonRecoverableNetworkError

Thrown if an HTTP code 501 is received

classsrc.databricks.sql.exc.RequestError

Thrown if there was a error during request to the server.

classsrc.databricks.sql.exc.SessionAlreadyClosedError

Thrown if CloseSession receives a code 404.

classsrc.databricks.sql.exc.TransactionError

Exception raised for transaction-specific errors.

methodsrc.databricks.sql.result_set.ResultSet.close() -> None

Close the result set.

methodsrc.databricks.sql.result_set.ResultSet.fetchall() -> List[Row]

Fetch all remaining rows of a query result.

methodsrc.databricks.sql.result_set.ResultSet.fetchall_arrow() -> 'pyarrow.Table'

Fetch all remaining rows as an Arrow table.

methodsrc.databricks.sql.result_set.ResultSet.fetchmany(size:int) -> List[Row]

Fetch the next set of rows of a query result.

methodsrc.databricks.sql.result_set.ResultSet.fetchmany_arrow(size:int) -> 'pyarrow.Table'

Fetch the next set of rows as an Arrow table.

methodsrc.databricks.sql.result_set.ResultSet.fetchone() -> Optional[Row]

Fetch the next row of a query result set.

classsrc.databricks.sql.result_set.ThriftResultSet

ResultSet implementation for the Thrift backend.

methodsrc.databricks.sql.session.Session.close() -> None

Close the underlying session.

methodsrc.databricks.sql.session.Session.get_autocommit() -> bool

Get the cached autocommit state for this session.

methodsrc.databricks.sql.session.Session.guid() -> Any

Get the raw session ID (backend-specific)

methodsrc.databricks.sql.session.Session.guid_hex() -> str

Get the session ID in hex format

methodsrc.databricks.sql.session.Session.session_id() -> SessionId

Get the normalized session ID

methodsrc.databricks.sql.session.Session.set_autocommit(value:bool) -> None

Update the cached autocommit state for this session.

classsrc.databricks.sql.telemetry.models.event.SqlExecutionEvent

Represents a SQL query execution event.

classsrc.databricks.sql.telemetry.telemetry_push_client.ITelemetryPushClient

Interface for telemetry push clients.

method

src.databricks.sql.telemetry.telemetry_push_client.ITelemetryPushClient.request(method:HttpMethod, url:str, headers:Optional[Dict[str, str]]=None, **kwargs) -> BaseHTTPResponse

Make an HTTP request.

classsrc.databricks.sql.telemetry.utils.BaseTelemetryClient

Base class for telemetry clients.

classsrc.databricks.sql.telemetry.utils.EnumEncoder

Custom JSON encoder to handle Enum values.

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.CancelDelegationToken_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.CancelDelegationToken_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.CancelOperation_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.CancelOperation_result

Attributes: - success

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.CancelDelegationToken(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.CancelOperation(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.CloseOperation(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.CloseSession(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.ExecuteStatement(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.FetchResults(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetCatalogs(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetColumns(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetCrossReference(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetDelegationToken(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetFunctions(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetInfo(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetOperationStatus(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetPrimaryKeys(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetResultSetMetadata(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetSchemas(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetTableTypes(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetTables(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.GetTypeInfo(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.OpenSession(req)

Parameters: - req

methodsrc.databricks.sql.thrift_api.TCLIService.TCLIService.Client.RenewDelegationToken(req)

Parameters: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.CloseOperation_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.CloseOperation_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.CloseSession_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.CloseSession_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.ExecuteStatement_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.ExecuteStatement_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.FetchResults_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.FetchResults_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetCatalogs_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetCatalogs_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetColumns_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetColumns_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetCrossReference_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetCrossReference_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetDelegationToken_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetDelegationToken_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetFunctions_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetFunctions_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetInfo_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetInfo_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetOperationStatus_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetOperationStatus_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetPrimaryKeys_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetPrimaryKeys_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetResultSetMetadata_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetResultSetMetadata_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetSchemas_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetSchemas_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetTableTypes_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetTableTypes_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetTables_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetTables_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetTypeInfo_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.GetTypeInfo_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.OpenSession_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.OpenSession_result

Attributes: - success

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.RenewDelegationToken_args

Attributes: - req

classsrc.databricks.sql.thrift_api.TCLIService.TCLIService.RenewDelegationToken_result

Attributes: - success

classsrc.databricks.sql.types.Row

A row in a query result.

funcsrc.databricks.sql.utils.escape_value(value:str) -> str

Escape special characters in tag values.

この情報について

掲載しているシグネチャは databricks/databricks-sql-python の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る