query_civis: Run a Query on Platform

In civis: R Client for the 'Civis Platform API'

Run a Query on Platform

Description

Utility to run queries that return no output.

A default database can be set using options(civis.default_db = "my_database"). If there is only one database available, this database will automatically be used as the default.

Usage

query_civis(x, ...)

## S3 method for class 'sql'
query_civis(x, database = NULL, verbose = FALSE, ...)

## S3 method for class 'numeric'
query_civis(x, verbose = FALSE, ...)

## S3 method for class 'character'
query_civis(x, database = NULL, verbose = FALSE, ...)

Arguments

x	sql("..."), "query", or id of an existing sql script.
...	arguments passed to queries_post.
database	string, Name of database where query is run.
verbose	bool, Print detailed updates of job status.

Methods (by class)

• query_civis(sql): Run a SQL query.

• query_civis(numeric): Run a SQL query from a previous SQL query id.

• query_civis(character): Run a SQL query.

See Also

read_civis for downloading results of SQL scripts from Civis Platform as a data frame.

io

Other io: download_civis(), query_civis_file(), read_civis(), write_civis(), write_civis_file()

Examples

## Not run: 
query_civis("GRANT ALL ON schema.my_table TO GROUP admin", "database", credential=0000)

## End(Not run)

civis documentation built on Aug. 30, 2025, 1:08 a.m.