Connector for connecting to Databricks using DBI

Extension of the connector::connector_dbi making it easier to connect to, and work with tables in Databricks.

Details

All methods for ConnectorDatabricksTable object are working from the catalog and schema provided when initializing the connection. This means you only need to provide the table name when using the built in methods. If you want to access tables outside of the chosen schema, you can either retrieve the connection with ConnectorDatabricksTable$conn or create a new connector.

When creating the connections to Databricks you either need to provide the sqlpath to Databricks cluster or the SQL warehouse you want to connect to. Authentication to databricks is handed by the odbc::databricks() driver and supports general use of personal access tokens and credentials through Posit Workbench. See also odbc::databricks() On more information on how the connection to Databricks is established.

Super classes

connector::Connector -> connector::ConnectorDBI -> ConnectorDatabricksTable

Active bindings

conn

The DBI connection object of the connector

catalog

The catalog used in the connector

schema

The schema used in the connector

Methods

Public methods

• ConnectorDatabricksTable$new()

• ConnectorDatabricksTable$clone()

Inherited methods

• connector::Connector$list_content_cnt()
• connector::Connector$print()
• connector::Connector$read_cnt()
• connector::Connector$remove_cnt()
• connector::Connector$write_cnt()
• connector::ConnectorDBI$disconnect_cnt()
• connector::ConnectorDBI$tbl_cnt()

---

Method new()

Initialize the connection to Databricks

Usage

ConnectorDatabricksTable$new(http_path, catalog, schema, extra_class = NULL)

Arguments

http_path

character The path to the Databricks cluster or SQL warehouse you want to connect to

catalog

character The catalog to use

schema

character The schema to use

extra_class

character Extra class to assign to the new connector

Returns

A ConnectorDatabricksTable object

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ConnectorDatabricksTable$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (FALSE) {
# Establish connection to your cluster

con_databricks <- ConnectorDatabricksTable$new(
  http_path = "path-to-cluster",
  catalog = "my_catalog",
  schema = "my_schema"
)

# List tables in my_schema

con_databricks$list_content()

# Read and write tables

con_databricks$write(mtcars, "my_mtcars_table")

con_databricks$read("my_mtcars_table")

# Use dplyr::tbl

con_databricks$tbl("my_mtcars_table")

# Remove table

con_databricks$remove("my_mtcars_table")

# Disconnect

con_databricks$disconnect()
}