com.databricks.sdk.service.catalog

Class ConnectionsAPI

java.lang.Object

com.databricks.sdk.service.catalog.ConnectionsAPI

@Generated
public class ConnectionsAPI
extends Object

Connections allow for creating a connection to an external data source.

A connection is an abstraction of an external data source that can be connected from Databricks Compute. Creating a connection object is the first step to managing external data sources within Unity Catalog, with the second step being creating a data object (catalog, schema, or table) using the connection. Data objects derived from a connection can be written to or read from similar to other Unity Catalog data objects based on cloud storage. Users may create different types of connections with each connection having a unique set of configuration options to support credential management and other settings.

Constructor Summary

Constructors

Constructor and Description
ConnectionsAPI(ApiClient apiClient) Regular-use constructor
ConnectionsAPI(ConnectionsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
ConnectionInfo	create(CreateConnection request) Creates a new connection
void	delete(DeleteConnectionRequest request) Deletes the connection that matches the supplied name.
void	delete(String name)
ConnectionInfo	get(GetConnectionRequest request) Gets a connection from it's name.
ConnectionInfo	get(String name)
ConnectionsService	impl()
Iterable<ConnectionInfo>	list(ListConnectionsRequest request) List all connections.
ConnectionInfo	update(UpdateConnection request) Updates the connection that matches the supplied name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectionsAPI

public ConnectionsAPI(ApiClient apiClient)

Regular-use constructor

ConnectionsAPI

public ConnectionsAPI(ConnectionsService mock)

Constructor for mocks

Method Detail

create

public ConnectionInfo create(CreateConnection request)

Creates a new connection

Creates a new connection to an external data source. It allows users to specify connection details and configurations for interaction with the external server.

delete

public void delete(String name)

delete

public void delete(DeleteConnectionRequest request)

Deletes the connection that matches the supplied name.

get

public ConnectionInfo get(String name)

get

public ConnectionInfo get(GetConnectionRequest request)

Gets a connection from it's name.

list

public Iterable<ConnectionInfo> list(ListConnectionsRequest request)

List all connections.

NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

update

public ConnectionInfo update(UpdateConnection request)

Updates the connection that matches the supplied name.

impl

public ConnectionsService impl()