Package index • nocodb

Common

Common functions that are of generic use.

api(): Call NocoDB API

Authentication

Functions to manage authentication against a NocoDB server.

sign_in(): Sign in NocoDB user

sign_out(): Sign out NocoDB user

api_tokens(): List NocoDB API tokens

create_api_token(): Create NocoDB API token

delete_api_token(): Delete NocoDB API token

Meta

Functions to work with NocoDB’s RESTful meta APIs.

Bases

Functions to manage NocoDB bases (aka “projects”).

bases(): List NocoDB bases

base_id(): Get NocoDB base ID

base(): Get NocoDB base

create_base(): Create NocoDB base

update_base(): Update NocoDB base

delete_base(): Delete NocoDB base

base_ui_acl(): List NocoDB base visibility rules

update_base_ui_acl(): Update NocoDB base visibility rules

Data sources

Functions to manage NocoDB data sources. Note data sources are conceptually abstracted by database integrations.

data_srcs(): List NocoDB data sources

data_src_id(): Get NocoDB data source ID

data_src(): Get NocoDB data source

test_data_src(): Test NocoDB data source

data_src_diff(): List NocoDB data source schema changes

has_data_src_diff(): Test if NocoDB data source has schema changes pending

sync_data_src(): Synchronize NocoDB data source schema

sync_data_src_eagerly(): Synchronize NocoDB data source schema eagerly

create_data_src(): Create NocoDB data source

update_data_src(): Update NocoDB data source

delete_data_src(): Delete NocoDB data source

data_src_tbls(): List tables in NocoDB data source

create_data_src_tbl(): Create table in NocoDB data source

Tables

Functions to manage NocoDB tables.

tbls(): List NocoDB tables

tbl_id(): Get NocoDB table ID

tbl(): Get NocoDB table

create_tbl(): Create NocoDB table

update_tbl(): Update NocoDB table

delete_tbl(): Delete NocoDB table

reorder_tbl(): Re-order NocoDB table

set_tbl_metadata(): Set metadata for NocoDB tables

Table views

Functions to manage NocoDB table views.

tbl_views(): List NocoDB table views

tbl_view_id(): Get NocoDB table view ID

tbl_view_cols(): List NocoDB table view columns

tbl_view_col_id(): Get NocoDB table view column ID

update_tbl_view_col(): Update NocoDB table view column

Grid views

update_grid_view_col(): Update NocoDB grid view column

Table columns

Functions to manage NocoDB table columns (aka “fields”).

tbl_cols(): List NocoDB table columns

tbl_col_id(): Get NocoDB table column ID

tbl_col(): Get NocoDB table column

create_tbl_col(): Create NocoDB table column

update_tbl_col(): Update NocoDB table column

delete_tbl_col(): Delete NocoDB table column

set_display_val(): Set display value column for NocoDB table

set_display_vals(): Set display value columns for multiple NocoDB tables

Attachments

Functions to manage NocoDB attachments.

upload_attachments(): Upload NocoDB attachments

Users

Functions to manage NocoDB users.

whoami(): Get NocoDB user info

users(): List NocoDB users

user_id(): Get NocoDB user ID

add_user(): Add NocoDB user account

update_user(): Update NocoDB user

delete_user(): Delete NocoDB user

invite_user(): Invite NocoDB user

sign_up_user(): Sign up NocoDB user

validate_user_email(): Validate NocoDB user e-mail

base_users(): List NocoDB base users

update_base_user(): Update NocoDB base user

delete_base_user(): Delete NocoDB base user

invite_base_user(): Invite NocoDB base user

resend_base_user_invitation(): Resend NocoDB base user invitation

Integrations {#integrations}

Functions to manage NocoDB integrations.

integrations(): List NocoDB integrations

integration_id(): Get NocoDB integration ID

integration(): Get NocoDB integration

create_integration(): Create NocoDB integration

update_integration(): Update NocoDB integration

delete_integration(): Delete NocoDB integration

Plugins

Functions to manage NocoDB plugins.

plugins(): List NocoDB plugins

plugin_id(): Get NocoDB plugin ID

plugin_category(): Get NocoDB plugin category

plugin(): Get NocoDB plugin

test_plugin(): Test NocoDB plugin configuration

update_plugin(): Update NocoDB plugin configuration

is_plugin_active(): Test if plugin is active

App settings

Functions to manage NocoDB’s application settings.

app_settings(): List NocoDB app settings

update_app_settings(): Update NocoDB app settings