createEXTENSION {pgTools}R Documentation

Generate a PostgreSQL CREATE EXTENSION statement, optionally execute the statement if con is not NULL.

Description

Generate a PostgreSQL CREATE EXTENSION statement, optionally execute the statement if con is not NULL.

Usage

createEXTENSION(
  name,
  if_not_exists = FALSE,
  schema = NULL,
  version = NULL,
  cascade = FALSE,
  con = NULL
)

Arguments

name

A string, the "extension_name" parameter for PostgreSQL CREATE EXTENSION.

if_not_exists

TRUE/FALSE, if TRUE, adds "IF NOT EXISTS" to PostgreSQL CREATE EXTENSION statement.

schema

A string, the "schema_name" parameter for PostgreSQL CREATE EXTENSION.

version

A string, the "version" parameter for PostgreSQL CREATE EXTENSION.

cascade

TRUE/FALSE, if TRUE, adds "CASCADE" to PostgreSQL CREATE EXTENSION statement.

con

A database connection that can be passed to DBI::dbSendQuery/DBI::dbGetQuery.

Value

A string, PostgreSQL CREATE EXTENSION statement; or the results retrieved by DBI::dbSendQuery after executing the statement.

Examples

createEXTENSION("pgcrypto")

[Package pgTools version 1.0.2 Index]