Test NocoDB plugin configuration

Tests the configuration of the plugin with the specified title and category on a NocoDB server via its POST /api/v1/db/meta/plugins/test API endpoint.

Usage

test_plugin(
  title,
  config,
  category = plugin_category(id_plugin = plugin_id(title = title, hostname = hostname,
    email = email, password = password, api_token = api_token), hostname = hostname,
    email = email, password = password, api_token = api_token),
  hostname = pal::pkg_config_val("hostname"),
  email = pal::pkg_config_val("email"),
  password = pal::pkg_config_val("password"),
  api_token = pal::pkg_config_val("api_token")
)

Arguments

title

NocoDB plugin title. A character scalar.

config

Plugin configuration. A list.

category

NocoDB plugin category as returned by plugin_category(). A character scalar.

hostname

NocoDB server hostname. A character scalar.

email

E-mail address of the NocoDB user to authenticate with.

password

Password of the NocoDB user to authenticate with.

api_token

NocoDB API token. Takes precedence over email and password if provided.

Value

TRUE if the test was successful.

See also

Other functions to manage NocoDB plugins: is_plugin_active(), plugin(), plugin_category(), plugin_id(), plugins(), update_plugin()

Examples

if (FALSE) { # \dontrun{
nocodb::test_plugin(title = "Backblaze B2",
                    config = list(bucket = "REPLACE-ME",
                                  region = "REPLACE-ME",
                                  access_key = "REPLACE-ME",
                                  access_secret = "REPLACE-ME"))

nocodb::test_plugin(title = "S3",
                    config = list(endpoint = "https://s3.REPLACE-ME.backblazeb2.com",
                                  region = "REPLACE-ME",
                                  bucket = "REPLACE-ME",
                                  access_key = "REPLACE-ME",
                                  access_secret = "REPLACE-ME",
                                  acl = "public-read"))} # }