Interface ConnectionsService
-
@Generated public interface ConnectionsService
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.
This is the high-level interface, that contains generated methods.
Evolving: this interface is under development. Method signatures may change.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ConnectionInfocreate(CreateConnection createConnection)Create a connection.voiddelete(DeleteConnectionRequest deleteConnectionRequest)Delete a connection.ConnectionInfoget(GetConnectionRequest getConnectionRequest)Get a connection.ListConnectionsResponselist()List connections.ConnectionInfoupdate(UpdateConnection updateConnection)Update a connection.
-
-
-
Method Detail
-
create
ConnectionInfo create(CreateConnection createConnection)
Create a connection.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
void delete(DeleteConnectionRequest deleteConnectionRequest)
Delete a connection.Deletes the connection that matches the supplied name.
-
get
ConnectionInfo get(GetConnectionRequest getConnectionRequest)
Get a connection.Gets a connection from it's name.
-
list
ListConnectionsResponse list()
List connections.List all connections.
-
update
ConnectionInfo update(UpdateConnection updateConnection)
Update a connection.Updates the connection that matches the supplied name.
-
-