Get NocoDB integration ID

Returns the identifier of the integration with the specified type, sub_type and/or title on a NocoDB server.

Usage

integration_id(
  title = NULL,
  type = "database",
  sub_type = c("mysql2", "pg", "sqlite3"),
  origin = pal::pkg_config_val("origin"),
  email = pal::pkg_config_val("email"),
  password = pal::pkg_config_val("password"),
  api_token = pal::pkg_config_val("api_token")
)

Arguments

title

pkgsnip::type("chr", 1L) NocoDB integration title. NULL means any title.

type

pkgsnip::type("chr", 1L) NocoDB integration type. One of "database", or NULL for any type.

sub_type

pkgsnip::type("chr", 1L) NocoDB integration subtype. One of "mysql2", "pg" or "sqlite3", or NULL for any subtype.

origin

character(1)
NocoDB server origin.

email

character(1)
E-mail address of the NocoDB user to authenticate with.

password

character(1)
Password of the NocoDB user to authenticate with.

api_token

character(1)
NocoDB API token. Takes precedence over email and password if provided.

Value

A character scalar.

Details

Note that NocoDB allows to create multiple integrations with the same title, type and sub_type, so integration_id() cannot discern such cases and just returns the identifier of the first integration listed in the API response (with a suitable warning).

See also

Other functions to manage NocoDB integrations: create_integration(), delete_integration(), integration(), integrations(), update_integration()