Starts a Quack server in the current DuckDB instance. Everything attached to
the session, including a DuckLake attached with attach_ducklake(), becomes
reachable by other DuckDB clients over the quack: protocol. The server runs
in the background of the DuckDB instance, so the R session stays usable.
Usage
quack_serve(
uri = "quack:localhost",
token = NULL,
allow_other_hostname = FALSE,
disable_ssl = FALSE,
secret = NULL,
create_secret_if_not_exists = FALSE,
ssl_cert_file = NULL,
ssl_key_file = NULL
)Arguments
- uri
Address to listen on (default
"quack:localhost"). The default port is 9494.- token
Authentication token that clients must supply (at least 4 characters). If
NULL, the server takes the token of the session's default Quack secret when there is one (seesecretandcreate_secret_if_not_exists), and otherwise generates a random token, which the returned data frame carries inauth_token. A server is never open: clients always present a token.- allow_other_hostname
Accept connections addressed to a hostname other than the one in
uri(defaultFALSE). A server reachable from other machines belongs behind a TLS-terminating reverse proxy.- disable_ssl
Serve over plain HTTP instead of HTTPS (default
FALSE, which leaves the choice to DuckDB: plain HTTP for a local address, HTTPS otherwise). Only appropriate on a trusted network.- secret
Optional name of an existing Quack secret whose token the server uses.
- create_secret_if_not_exists
When no
tokenis given and no default Quack secret exists, store the generated token in a persistent default secret, so later servers (and clients in this session) reuse it (defaultFALSE).- ssl_cert_file, ssl_key_file
Optional certificate and private key files for serving over HTTPS, such as the pair
quack_generate_keys()writes. Without them DuckDB generates a self-signed certificate when it serves HTTPS.
Value
Invisibly, a data frame with one row: listen_uri, listen_url,
and auth_token, the token clients must present.
Examples
if (FALSE) { # \dontrun{
attach_ducklake("trial", lake_path = "path/to/lake")
quack_serve(token = "super_secret")
# ... colleagues connect with attach_quack() ...
quack_stop()
# Let DuckDB pick the token and keep it in a secret for later servers
server <- quack_serve(create_secret_if_not_exists = TRUE)
server$auth_token
} # }
