chTKCat: Connect to a ClickHouse TKCat instance

View source: R/chTKCat.R

chTKCatR Documentation

Connect to a ClickHouse TKCat instance

Description

Connect to a ClickHouse TKCat instance

Usage

chTKCat(
  host = "localhost",
  port = 9111L,
  user = "default",
  password,
  settings = list(max_query_size = 1073741824, use_uncompressed_cache = 0, load_balancing
    = "random", max_memory_usage = 0, allow_introspection_functions = 1,
    joined_subquery_requires_alias = 0),
  ports = NULL,
  drv = ClickHouseHTTP::ClickHouseHTTP(),
  ...
)

Arguments

host

a character string specifying the host heberging the database (default: localhost)

port

an integer specifying the port on which the database is listening (default: 9111)

user

user name

password

user password

settings

list of Clickhouse settings

ports

a named list of available ports for accessing ClickHouse (default: NULL; example: c(Native=9101, HTTP=9111))

drv

a DBI driver for connecting to ClickHouse (default: ClickHouseHTTP::ClickHouseHTTP(); other supported driver: RClickhouse::clickhouse())

...

additional parameters for connection (see ClickHouseHTTP::dbConnect,ClickHouseHTTPDriver-method for the default driver)

Value

a chTKCat object

See Also

check_chTKCat(), db_disconnect(), db_reconnect()


TKCat documentation built on Feb. 16, 2023, 10:51 p.m.