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, origin = origin, email
    = email, password = password, api_token = api_token), origin = origin, email = email,
    password = password, api_token = api_token),
  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

character(1)
NocoDB plugin title.

config

list()
Plugin configuration.

category

character(1)
NocoDB plugin category as returned by plugin_category().

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

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"))} # }