From 471d79e8f9bafb29787cc583c7e48bbef7cd9d1e Mon Sep 17 00:00:00 2001 From: Raju Udava <86527202+dstala@users.noreply.github.com> Date: Wed, 11 Oct 2023 13:05:00 +0530 Subject: [PATCH] docs: build Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com> --- packages/noco-docs/dist/0.109.7/FAQs/index.html | 4 ++-- .../0.109.7/developer-resources/accessing-apis/index.html | 4 ++-- .../dist/0.109.7/developer-resources/rest-apis/index.html | 4 ++-- .../dist/0.109.7/developer-resources/sdk/index.html | 4 ++-- .../0.109.7/developer-resources/upload-via-api/index.html | 4 ++-- .../dist/0.109.7/developer-resources/webhooks/index.html | 4 ++-- .../dist/0.109.7/engineering/architecture/index.html | 4 ++-- .../dist/0.109.7/engineering/builds-and-releases/index.html | 4 ++-- .../dist/0.109.7/engineering/development-setup/index.html | 4 ++-- .../dist/0.109.7/engineering/playwright/index.html | 4 ++-- .../0.109.7/engineering/repository-structure/index.html | 4 ++-- .../dist/0.109.7/engineering/translation/index.html | 4 ++-- .../dist/0.109.7/engineering/unit-testing/index.html | 4 ++-- .../noco-docs/dist/0.109.7/getting-started/demos/index.html | 4 ++-- .../getting-started/environment-variables/index.html | 4 ++-- .../dist/0.109.7/getting-started/installation/index.html | 4 ++-- .../dist/0.109.7/getting-started/upgrading/index.html | 4 ++-- packages/noco-docs/dist/0.109.7/index.html | 4 ++-- .../0.109.7/setup-and-usages/account-settings/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/audit/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/code-snippets/index.html | 4 ++-- .../0.109.7/setup-and-usages/column-operations/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/column-types/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/dashboard/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/display-value/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/expanded-form/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/formulas/index.html | 4 ++-- .../index.html | 4 ++-- .../0.109.7/setup-and-usages/keyboard-maneuver/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/languages/index.html | 4 ++-- .../setup-and-usages/link-to-another-record/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/links/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/lookup/index.html | 4 ++-- .../0.109.7/setup-and-usages/meta-management/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/primary-key/index.html | 4 ++-- .../0.109.7/setup-and-usages/project-settings/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/rollup/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/share-base/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/share-view/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/sync-schema/index.html | 4 ++-- .../0.109.7/setup-and-usages/table-operations/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/team-and-auth/index.html | 4 ++-- .../0.109.7/setup-and-usages/usage-information/index.html | 4 ++-- .../dist/0.109.7/setup-and-usages/views/index.html | 4 ++-- packages/noco-docs/dist/404.html | 4 ++-- packages/noco-docs/dist/FAQs/index.html | 6 +++--- .../noco-docs/dist/account-settings/api-tokens/index.html | 6 +++--- .../dist/account-settings/oss-specific-details/index.html | 6 +++--- .../noco-docs/dist/account-settings/profile-page/index.html | 6 +++--- .../js/{935f2afb.56686250.js => 935f2afb.db7a4e77.js} | 2 +- .../{runtime~main.89e98ddf.js => runtime~main.da55b9eb.js} | 2 +- .../dist/automation/webhook/actions-on-webhook/index.html | 6 +++--- .../dist/automation/webhook/create-webhook/index.html | 6 +++--- .../dist/automation/webhook/webhook-overview/index.html | 6 +++--- packages/noco-docs/dist/bases/actions-on-base/index.html | 6 +++--- packages/noco-docs/dist/bases/base-collaboration/index.html | 6 +++--- packages/noco-docs/dist/bases/base-overview/index.html | 6 +++--- packages/noco-docs/dist/bases/create-base/index.html | 6 +++--- .../dist/bases/import-base-from-airtable/index.html | 6 +++--- packages/noco-docs/dist/bases/share-base/index.html | 6 +++--- .../dist/collaboration/base-collaboration/index.html | 6 +++--- .../dist/collaboration/collaboration-overview/index.html | 6 +++--- .../dist/collaboration/oss-specific-details/index.html | 6 +++--- packages/noco-docs/dist/collaboration/share-base/index.html | 6 +++--- packages/noco-docs/dist/collaboration/share-view/index.html | 6 +++--- .../dist/collaboration/workspace-collaboration/index.html | 6 +++--- .../dist/data-sources/actions-on-data-sources/index.html | 6 +++--- .../dist/data-sources/connect-to-data-source/index.html | 6 +++--- .../dist/data-sources/data-source-overview/index.html | 6 +++--- .../dist/data-sources/sync-with-data-source/index.html | 6 +++--- packages/noco-docs/dist/engineering/architecture/index.html | 6 +++--- .../dist/engineering/builds-and-releases/index.html | 6 +++--- .../noco-docs/dist/engineering/development-setup/index.html | 6 +++--- packages/noco-docs/dist/engineering/playwright/index.html | 6 +++--- .../dist/engineering/repository-structure/index.html | 6 +++--- packages/noco-docs/dist/engineering/translation/index.html | 6 +++--- packages/noco-docs/dist/engineering/unit-testing/index.html | 6 +++--- packages/noco-docs/dist/engineering/writing-docs/index.html | 6 +++--- packages/noco-docs/dist/fields/actions-on-field/index.html | 6 +++--- packages/noco-docs/dist/fields/display-value/index.html | 6 +++--- .../dist/fields/field-types/custom-types/QR-code/index.html | 6 +++--- .../fields/field-types/custom-types/attachment/index.html | 6 +++--- .../dist/fields/field-types/custom-types/barcode/index.html | 6 +++--- .../fields/field-types/custom-types/geometry/index.html | 6 +++--- .../dist/fields/field-types/custom-types/json/index.html | 6 +++--- .../field-types/custom-types/specific-db-type/index.html | 6 +++--- .../fields/field-types/date-time-based/date-time/index.html | 6 +++--- .../dist/fields/field-types/date-time-based/date/index.html | 6 +++--- .../fields/field-types/date-time-based/duration/index.html | 6 +++--- .../dist/fields/field-types/date-time-based/time/index.html | 6 +++--- .../field-types/formula/conditional-expressions/index.html | 6 +++--- .../fields/field-types/formula/date-functions/index.html | 6 +++--- .../dist/fields/field-types/formula/formula/index.html | 6 +++--- .../fields/field-types/formula/numeric-functions/index.html | 6 +++--- .../dist/fields/field-types/formula/operators/index.html | 6 +++--- .../fields/field-types/formula/string-functions/index.html | 6 +++--- .../dist/fields/field-types/links-based/links/index.html | 6 +++--- .../dist/fields/field-types/links-based/lookup/index.html | 6 +++--- .../dist/fields/field-types/links-based/rollup/index.html | 6 +++--- .../dist/fields/field-types/numerical/currency/index.html | 6 +++--- .../dist/fields/field-types/numerical/decimal/index.html | 6 +++--- .../dist/fields/field-types/numerical/number/index.html | 6 +++--- .../dist/fields/field-types/numerical/percent/index.html | 6 +++--- .../fields/field-types/select-based/checkbox/index.html | 6 +++--- .../fields/field-types/select-based/multi-select/index.html | 6 +++--- .../dist/fields/field-types/select-based/rating/index.html | 6 +++--- .../field-types/select-based/single-select/index.html | 6 +++--- .../dist/fields/field-types/text-based/email/index.html | 6 +++--- .../dist/fields/field-types/text-based/long-text/index.html | 6 +++--- .../fields/field-types/text-based/phonenumber/index.html | 6 +++--- .../field-types/text-based/single-line-text/index.html | 6 +++--- .../dist/fields/field-types/text-based/url/index.html | 6 +++--- packages/noco-docs/dist/fields/fields-overview/index.html | 6 +++--- .../noco-docs/dist/fields/multi-fields-editor/index.html | 6 +++--- packages/noco-docs/dist/fields/primary-key/index.html | 6 +++--- .../dist/getting-started/keyboard-shortcuts/index.html | 6 +++--- .../noco-docs/dist/getting-started/quick-start/index.html | 6 +++--- .../self-hosted/environment-variables/index.html | 6 +++--- .../getting-started/self-hosted/installation/index.html | 6 +++--- .../dist/getting-started/self-hosted/upgrading/index.html | 6 +++--- .../noco-docs/dist/getting-started/terminologies/index.html | 6 +++--- packages/noco-docs/dist/index.html | 6 +++--- .../noco-docs/dist/records/actions-on-record/index.html | 6 +++--- packages/noco-docs/dist/records/create-record/index.html | 6 +++--- packages/noco-docs/dist/records/expand-record/index.html | 6 +++--- packages/noco-docs/dist/records/records-overview/index.html | 6 +++--- .../roles-permissions-overview/index.html | 6 +++--- packages/noco-docs/dist/search/index.html | 4 ++-- .../dist/table-details/table-details-overview/index.html | 6 +++--- .../noco-docs/dist/table-operations/download/index.html | 6 +++--- .../dist/table-operations/field-operations/index.html | 6 +++--- packages/noco-docs/dist/table-operations/filter/index.html | 6 +++--- .../noco-docs/dist/table-operations/group-by/index.html | 6 +++--- .../noco-docs/dist/table-operations/overview/index.html | 6 +++--- .../noco-docs/dist/table-operations/row-height/index.html | 6 +++--- packages/noco-docs/dist/table-operations/search/index.html | 6 +++--- packages/noco-docs/dist/table-operations/sort/index.html | 6 +++--- packages/noco-docs/dist/tables/actions-on-table/index.html | 6 +++--- .../dist/tables/create-table-via-import/index.html | 6 +++--- packages/noco-docs/dist/tables/create-table/index.html | 6 +++--- .../dist/tables/import-data-into-existing-table/index.html | 6 +++--- packages/noco-docs/dist/tables/table-overview/index.html | 6 +++--- packages/noco-docs/dist/tags/account-settings/index.html | 4 ++-- packages/noco-docs/dist/tags/api-tokens/index.html | 4 ++-- packages/noco-docs/dist/tags/attachment/index.html | 4 ++-- packages/noco-docs/dist/tags/audit/index.html | 4 ++-- packages/noco-docs/dist/tags/barcode/index.html | 4 ++-- packages/noco-docs/dist/tags/bases/index.html | 4 ++-- packages/noco-docs/dist/tags/checkbox/index.html | 4 ++-- packages/noco-docs/dist/tags/collaboration/index.html | 4 ++-- packages/noco-docs/dist/tags/comments/index.html | 4 ++-- packages/noco-docs/dist/tags/connect/index.html | 4 ++-- packages/noco-docs/dist/tags/cover-image/index.html | 4 ++-- packages/noco-docs/dist/tags/create/index.html | 4 ++-- packages/noco-docs/dist/tags/csv/index.html | 4 ++-- packages/noco-docs/dist/tags/currency/index.html | 4 ++-- packages/noco-docs/dist/tags/custom-types/index.html | 4 ++-- packages/noco-docs/dist/tags/dashboard/index.html | 4 ++-- packages/noco-docs/dist/tags/data-sources/index.html | 4 ++-- packages/noco-docs/dist/tags/date-time/index.html | 4 ++-- packages/noco-docs/dist/tags/decimal/index.html | 4 ++-- packages/noco-docs/dist/tags/delete/index.html | 4 ++-- packages/noco-docs/dist/tags/disable/index.html | 4 ++-- packages/noco-docs/dist/tags/display-value/index.html | 4 ++-- packages/noco-docs/dist/tags/download/index.html | 4 ++-- packages/noco-docs/dist/tags/duplicate/index.html | 4 ++-- packages/noco-docs/dist/tags/edit/index.html | 4 ++-- packages/noco-docs/dist/tags/email/index.html | 4 ++-- packages/noco-docs/dist/tags/enable/index.html | 4 ++-- packages/noco-docs/dist/tags/engineering/index.html | 4 ++-- packages/noco-docs/dist/tags/excel/index.html | 4 ++-- packages/noco-docs/dist/tags/expanded-record/index.html | 4 ++-- packages/noco-docs/dist/tags/external/index.html | 4 ++-- packages/noco-docs/dist/tags/field-types/index.html | 4 ++-- packages/noco-docs/dist/tags/field-width/index.html | 4 ++-- packages/noco-docs/dist/tags/fields/index.html | 4 ++-- packages/noco-docs/dist/tags/filter/index.html | 4 ++-- packages/noco-docs/dist/tags/form-view/index.html | 4 ++-- packages/noco-docs/dist/tags/formula/index.html | 4 ++-- packages/noco-docs/dist/tags/gallery-view/index.html | 4 ++-- packages/noco-docs/dist/tags/geometry/index.html | 4 ++-- packages/noco-docs/dist/tags/getting-started/index.html | 4 ++-- packages/noco-docs/dist/tags/grid-view/index.html | 4 ++-- packages/noco-docs/dist/tags/group-by/index.html | 4 ++-- packages/noco-docs/dist/tags/hide/index.html | 4 ++-- packages/noco-docs/dist/tags/import/index.html | 4 ++-- packages/noco-docs/dist/tags/index.html | 4 ++-- packages/noco-docs/dist/tags/invite/index.html | 4 ++-- packages/noco-docs/dist/tags/json/index.html | 4 ++-- packages/noco-docs/dist/tags/kanban-view/index.html | 4 ++-- packages/noco-docs/dist/tags/links-based-types/index.html | 4 ++-- packages/noco-docs/dist/tags/links/index.html | 4 ++-- packages/noco-docs/dist/tags/long-text/index.html | 4 ++-- packages/noco-docs/dist/tags/lookup/index.html | 4 ++-- packages/noco-docs/dist/tags/member/index.html | 4 ++-- packages/noco-docs/dist/tags/members/index.html | 4 ++-- packages/noco-docs/dist/tags/multi-fields-editor/index.html | 4 ++-- packages/noco-docs/dist/tags/multi-select/index.html | 4 ++-- packages/noco-docs/dist/tags/my-sql/index.html | 4 ++-- packages/noco-docs/dist/tags/number/index.html | 4 ++-- packages/noco-docs/dist/tags/numerical-types/index.html | 4 ++-- packages/noco-docs/dist/tags/open-source/index.html | 4 ++-- packages/noco-docs/dist/tags/overview/index.html | 4 ++-- packages/noco-docs/dist/tags/percent/index.html | 4 ++-- packages/noco-docs/dist/tags/permissions/index.html | 4 ++-- packages/noco-docs/dist/tags/pg/index.html | 4 ++-- packages/noco-docs/dist/tags/phone-number/index.html | 4 ++-- packages/noco-docs/dist/tags/primary-key/index.html | 4 ++-- packages/noco-docs/dist/tags/productivity-hacks/index.html | 4 ++-- packages/noco-docs/dist/tags/profile/index.html | 4 ++-- packages/noco-docs/dist/tags/qr-code/index.html | 4 ++-- packages/noco-docs/dist/tags/rating/index.html | 4 ++-- packages/noco-docs/dist/tags/record-height/index.html | 4 ++-- packages/noco-docs/dist/tags/records/index.html | 4 ++-- packages/noco-docs/dist/tags/relations/index.html | 4 ++-- packages/noco-docs/dist/tags/remove/index.html | 4 ++-- packages/noco-docs/dist/tags/rename/index.html | 4 ++-- packages/noco-docs/dist/tags/reorder/index.html | 4 ++-- packages/noco-docs/dist/tags/rest-ap-is/index.html | 4 ++-- packages/noco-docs/dist/tags/roles/index.html | 4 ++-- packages/noco-docs/dist/tags/rollup/index.html | 4 ++-- packages/noco-docs/dist/tags/search/index.html | 4 ++-- packages/noco-docs/dist/tags/select-based-types/index.html | 4 ++-- packages/noco-docs/dist/tags/share-base/index.html | 4 ++-- packages/noco-docs/dist/tags/share/index.html | 4 ++-- packages/noco-docs/dist/tags/shortcuts/index.html | 4 ++-- packages/noco-docs/dist/tags/show-hide/index.html | 4 ++-- packages/noco-docs/dist/tags/single-line-text/index.html | 4 ++-- packages/noco-docs/dist/tags/single-select/index.html | 4 ++-- packages/noco-docs/dist/tags/sort/index.html | 4 ++-- packages/noco-docs/dist/tags/specific-db-type/index.html | 4 ++-- packages/noco-docs/dist/tags/swagger/index.html | 4 ++-- packages/noco-docs/dist/tags/sync/index.html | 4 ++-- packages/noco-docs/dist/tags/table-details/index.html | 4 ++-- packages/noco-docs/dist/tags/table-operations/index.html | 4 ++-- packages/noco-docs/dist/tags/table/index.html | 4 ++-- packages/noco-docs/dist/tags/tables/index.html | 4 ++-- packages/noco-docs/dist/tags/text-based-types/index.html | 4 ++-- packages/noco-docs/dist/tags/ui-acl/index.html | 4 ++-- packages/noco-docs/dist/tags/upload/index.html | 4 ++-- packages/noco-docs/dist/tags/url/index.html | 4 ++-- packages/noco-docs/dist/tags/views/index.html | 4 ++-- packages/noco-docs/dist/tags/visibility/index.html | 4 ++-- packages/noco-docs/dist/tags/webhook/index.html | 4 ++-- packages/noco-docs/dist/tags/workspaces/index.html | 4 ++-- packages/noco-docs/dist/views/actions-on-view/index.html | 6 +++--- packages/noco-docs/dist/views/create-view/index.html | 6 +++--- packages/noco-docs/dist/views/share-view/index.html | 6 +++--- packages/noco-docs/dist/views/view-types/form/index.html | 6 +++--- packages/noco-docs/dist/views/view-types/gallery/index.html | 6 +++--- packages/noco-docs/dist/views/view-types/grid/index.html | 6 +++--- packages/noco-docs/dist/views/view-types/kanban/index.html | 6 +++--- packages/noco-docs/dist/views/views-overview/index.html | 6 +++--- .../dist/workspaces/actions-on-workspace/index.html | 6 +++--- .../noco-docs/dist/workspaces/create-workspace/index.html | 6 +++--- .../dist/workspaces/workspace-collaboration/index.html | 6 +++--- .../noco-docs/dist/workspaces/workspace-overview/index.html | 6 +++--- 257 files changed, 618 insertions(+), 618 deletions(-) rename packages/noco-docs/dist/assets/js/{935f2afb.56686250.js => 935f2afb.db7a4e77.js} (97%) rename packages/noco-docs/dist/assets/js/{runtime~main.89e98ddf.js => runtime~main.da55b9eb.js} (99%) diff --git a/packages/noco-docs/dist/0.109.7/FAQs/index.html b/packages/noco-docs/dist/0.109.7/FAQs/index.html index 2d31890948..91fb9fce9e 100644 --- a/packages/noco-docs/dist/0.109.7/FAQs/index.html +++ b/packages/noco-docs/dist/0.109.7/FAQs/index.html @@ -4,7 +4,7 @@ FAQs | NocoDB - + @@ -12,7 +12,7 @@
Skip to main content
Version: 0.109.7 - Old UI

FAQs

How to upgrade NocoDB ?​

How to export CSV from the grid view ?​

How to share the project with read only access ?​

  • Either you can invite by email with 'viewer' access control
  • Share the base with publicly accessible link. Available since 0.82.0

How to check my current NocoDB version ?​

  • You can hover the NocoDB icon on the top left corner or check PackageVersion in Project info.

image

How to check my Project info ?​

  • You can click on top right icon and click Copy Project Info.

image

You should see the similar result as below.

Node: **v16.14.0**
Arch: **arm64**
Platform: **darwin**
Docker: **false**
Database: **mysql2**
ProjectOnRootDB: **true**
RootDB: **mysql2**
PackageVersion: **0.97.0**

What is available in free version ?​

  • Detailed comparison of NocoDB's generous CE compared to others is here.
  • NocoDB has just one version that is free & open source.
  • In it you will notice advanced features are all available for free.
    • ACL
    • Collaboration
    • Advanced Views : Form View, Gallery View & Kanban View
    • Share View
    • Embed View
    • Password protected View
    • Automations
    • API Token Support
  • And we would never move these features from free to an enterprise version of NocoDB.
  • There is no limitations to number of projects, rows or columns either.

What is the difference between Auth Token and API Token ?​

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN. If you are passing Auth Token, make sure that the header is called xc-auth.

API Token is a Nano ID with a length of 40. If you are passing API Token, make sure that the header is called xc-token.

Do we plan to have an Enterprise Edition?​

For features that make sense for enterprises like below - yes

  • SSO, SLA, Organisation wide reports and analytics,
  • Advanced Audit or ACL,
  • Bespoke implementations & integrations,
  • A hosted solution.

And increasing number of our customers are requesting it.

How do we decide if a feature is Enterprise or not ?​

  • Depends on the effort and whether the intended users are enterprises.

What are the official socials for NocoDB?​

Is NocoDB available on the cloud?​

Soon! NocoDB is currently developing cloud infrastructure. To join the upcoming FREE private beta program, fill out this form here and be the first to try it!

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/developer-resources/accessing-apis/index.html b/packages/noco-docs/dist/0.109.7/developer-resources/accessing-apis/index.html index 8ede8ad907..c48687504e 100644 --- a/packages/noco-docs/dist/0.109.7/developer-resources/accessing-apis/index.html +++ b/packages/noco-docs/dist/0.109.7/developer-resources/accessing-apis/index.html @@ -4,14 +4,14 @@ Accessing APIs | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Accessing APIs

NocoDB APIs can be authorized by either Auth Token or API Token.

Auth Token​

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN. If you are passing Auth Token, make sure that the header is called xc-auth.

  • Go to NocoDB Project, click the rightmost button and click Copy Auth Token.
image

API Token​

API tokens allows us to integrate seamlessly with 3rd party apps. See API Tokens Management for more.

Swagger UI​

You can interact with the API's resources via Swagger UI.

  • Go to NocoDB Project, click the rightmost button and click Swagger APIs Doc.
image
  • Click Authorize, paste the token you copied in above steps and click Authorize to save.

image

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/developer-resources/rest-apis/index.html b/packages/noco-docs/dist/0.109.7/developer-resources/rest-apis/index.html index 081b0605ce..9c187a54f7 100644 --- a/packages/noco-docs/dist/0.109.7/developer-resources/rest-apis/index.html +++ b/packages/noco-docs/dist/0.109.7/developer-resources/rest-apis/index.html @@ -4,13 +4,13 @@ REST APIs | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

REST APIs

Once you've created the schemas, you can manipulate the data or invoke actions using the REST APIs. We provide several types of APIs for different usages as below.

API Overview​

Here's the overview of all APIs. For the details, please check out NocoDB API Documentation.

You may also interact with the API's resources via Swagger UI.

note

Currently, the default value for {orgs} is noco. Users will be able to change it in the future release.

Auth APIs​

CategoryMethodTagFunction NamePath
AuthPostauthsignup/api/v1/auth/user/signup
AuthPostauthsignin/api/v1/auth/user/signin
AuthGetauthme/api/v1/auth/user/me
AuthPostauthpasswordForgot/api/v1/auth/password/forgot
AuthPostauthpasswordChange/api/v1/auth/password/change
AuthPostauthpasswordReset/api/v1/auth/password/reset/{token}
AuthPostauthtokenRefresh/api/v1/auth/token/refresh
AuthPostauthpasswordResetTokenValidate/api/v1/auth/token/validate/{token}
AuthPostauthemailValidate/api/v1/auth/email/validate/{email}

Public APIs​

CategoryMethodTagFunction NamePath
PublicGetpublicsharedBaseGet/api/v1/db/public/shared-base/{sharedBaseUuid}/meta
PublicPostpublicdataList/api/v1/db/public/shared-view/{sharedViewUuid}/rows
PublicGetpublicdataNestedList/api/v1/db/public/shared-view/{sharedViewUuid}/rows/{rowId}/{relationType}/{columnName}
PublicPostpublicdataCreate/api/v1/db/public/shared-view/{sharedViewUuid}/rows
PublicGetpubliccsvExport/api/v1/db/public/shared-view/{sharedViewUuid}/rows/export/{type}
PublicGetpublicdataRelationList/api/v1/db/public/shared-view/{sharedViewUuid}/nested/{columnName}
PublicGetpublicsharedViewMetaGet/api/v1/db/public/shared-view/{sharedViewUuid}/meta
PublicGetpublicgroupedDataList/api/v1/db/public/shared-view/{sharedViewUuid}/group/{columnId}

Data APIs​

CategoryMethodTagFunction NamePath
DataDeletedbTableRowbulkDelete/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/
DataPostdbTableRowbulkCreate/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/
DataPatchdbTableRowbulkUpdate/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/
DataPatchdbTableRowbulkUpdateAll/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all
DataDeletedbTableRowbulkDeleteAll/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all
DataGetdbTableRowlist/api/v1/db/data/{orgs}/{projectName}/{tableName}
DataGetdbTableRowfindOne/api/v1/db/data/{orgs}/{projectName}/{tableName}/find-one
DataGetdbTableRowgroupBy/api/v1/db/data/{orgs}/{projectName}/{tableName}/groupby
DataGetdbTableRowexist/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/exist
DataPostdbTableRowcreate/api/v1/db/data/{orgs}/{projectName}/{tableName}
DataGetdbTableRowread/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}
DataPatchdbTableRowupdate/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}
DataDeletedbTableRowdelete/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}
DataGetdbTableRowcount/api/v1/db/data/{orgs}/{projectName}/{tableName}/count
DataGetdbTableRowgroupedDataList/api/v1/db/data/{orgs}/{projectName}/{tableName}/group/{columnId}
DataGetdbViewRowlist/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}
DataGetdbViewRowfindOne/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/find-one
DataGetdbViewRowgroupBy/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/groupby
DataGetdbViewRowexist/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}/exist
DataPostdbViewRowcreate/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}
DataGetdbViewRowread/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}
DataPatchdbViewRowupdate/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}
DataDeletedbViewRowdelete/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}
DataGetdbViewRowcount/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/count
DataGetdbViewRowgroupedDataList/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/group/{columnId}

Meta APIs​

CategoryMethodTagFunction NamePath
MetaGetapiTokenlist/api/v1/db/meta/projects/{projectId}/api-tokens
MetaPostapiTokencreate/api/v1/db/meta/projects/{projectId}/api-tokens
MetaDeleteapiTokendelete/api/v1/db/meta/projects/{projectId}/api-tokens/{token}
MetaGetauthprojectUserList/api/v1/db/meta/projects/{projectId}/users
MetaPostauthprojectUserAdd/api/v1/db/meta/projects/{projectId}/users
MetaPatchauthprojectUserUpdate/api/v1/db/meta/projects/{projectId}/users/{userId}
MetaDeleteauthprojectUserRemove/api/v1/db/meta/projects/{projectId}/users/{userId}
MetaPostauthprojectUserResendInvite/api/v1/db/meta/projects/{projectId}/users/{userId}/resend-invite
MetaPostdbTablecreate/api/v1/db/meta/projects/{projectId}/tables
MetaGetdbTablelist/api/v1/db/meta/projects/{projectId}/tables
MetaPostdbTableColumncreate/api/v1/db/meta/tables/{tableId}/columns
MetaPatchdbTableColumnupdate/api/v1/db/meta/tables/{tableId}/columns/{columnId}
MetaDeletedbTableColumndelete/api/v1/db/meta/tables/{tableId}/columns/{columnId}
MetaPostdbTableColumnprimaryColumnSet/api/v1/db/meta/tables/{tableId}/columns/{columnId}/primary
MetaGetdbTableFilterget/api/v1/db/meta/filters/{filterId}
MetaPatchdbTableFilterupdate/api/v1/db/meta/filters/{filterId}
MetaDeletedbTableFilterdelete/api/v1/db/meta/filters/{filterId}
MetaGetdbTableFilterread/api/v1/db/meta/views/{viewId}/filters
MetaPostdbTableFiltercreate/api/v1/db/meta/views/{viewId}/filters
MetaGetdbTableFilterget/api/v1/db/meta/filters/{filterId}
MetaPatchdbTableFilterupdate/api/v1/db/meta/filters/{filterId}
MetaDeletedbTableFilterdelete/api/v1/db/meta/filters/{filterId}
MetaGetdbTableFilterchildrenRead/api/v1/db/meta/filters/{filterGroupId}/children
MetaGetdbTableSortlist/api/v1/db/meta/views/{viewId}/sorts
MetaPostdbTableSortcreate/api/v1/db/meta/views/{viewId}/sorts
MetaGetdbTableSortread/api/v1/db/meta/sorts/{sortId}
MetaPatchdbTableSortupdate/api/v1/db/meta/sorts/{sortId}
MetaDeletedbTableSortdelete/api/v1/db/meta/sorts/{sortId}/api/v1/db
MetaPatchdbTableWebhookupdate/api/v1/db/meta/hooks/{hookId}
MetaDeletedbTableWebhookdelete/api/v1/db/meta/hooks/{hookId}
MetaGetdbTableWebhooklist/api/v1/db/meta/tables/{tableId}/hooks
MetaPostdbTableWebhookcreate/api/v1/db/meta/tables/{tableId}/hooks
MetaPostdbTableWebhooktest/api/v1/db/meta/tables/{tableId}/hooks/test
MetaGetdbTableWebhooksamplePayloadGet/api/v1/db/meta/tables/{tableId}/hooks/samplePayload/{operation}
MetaGetdbTableWebhookFilterread/api/v1/db/meta/hooks/{hookId}/filters
MetaPostdbTableWebhookFiltercreate/api/v1/db/meta/hooks/{hookId}/filters
MetaGetdbViewlist/api/v1/db/meta/tables/{tableId}/views
MetaGetdbViewread/api/v1/db/meta/tables/{tableId}
MetaPatchdbViewupdate/api/v1/db/meta/tables/{tableId}
MetaDeletedbViewdelete/api/v1/db/meta/tables/{tableId}
MetaPostdbViewreorder/api/v1/db/meta/tables/{tableId}/reorder
MetaPostdbViewformCreate/api/v1/db/meta/tables/{tableId}/forms
MetaPatchdbViewformUpdate/api/v1/db/meta/forms/{formViewId}
MetaGetdbViewformRead/api/v1/db/meta/forms/{formViewId}
MetaPatchdbViewformColumnUpdate/api/v1/db/meta/form-columns/{formViewColumnId}
MetaPostdbViewgalleryCreate/api/v1/db/meta/tables/{tableId}/galleries
MetaPatchdbViewgalleryUpdate/api/v1/db/meta/galleries/{galleryViewId}
MetaGetdbViewgalleryRead/api/v1/db/meta/galleries/{galleryViewId}
MetaPostdbViewkanbanCreate/api/v1/db/meta/tables/{tableId}/kanbans
MetaPatchdbViewkanbanUpdate/api/v1/db/meta/kanban/{kanbanViewId}
MetaGetdbViewkanbanRead/api/v1/db/meta/kanbans/{kanbanViewId}
MetaPostdbViewmapCreate/api/v1/db/meta/tables/{tableId}/maps
MetaPatchdbViewmapUpdate/api/v1/db/meta/maps/{mapViewId}
MetaGetdbViewmapRead/api/v1/db/meta/maps/{mapViewId}
MetaPostdbViewgridCreate/api/v1/db/meta/tables/{tableId}/grids
MetaGetdbViewgridColumnsList/api/v1/db/meta/grids/{gridId}/grid-columns
MetaPatchdbViewgridColumnUpdate/api/v1/db/meta/grid-columns/{columnId}
MetaPatchdbViewupdate/api/v1/db/meta/views/{viewId}
MetaDeletedbViewdelete/api/v1/db/meta/views/{viewId}
MetaPostdbViewshowAllColumn/api/v1/db/meta/views/{viewId}/show-all
MetaPostdbViewhideAllColumn/api/v1/db/meta/views/{viewId}/hide-all
MetaGetdbViewColumnlist/api/v1/db/meta/views/{viewId}/columns
MetaPostdbViewColumncreate/api/v1/db/meta/views/{viewId}/columns
MetaPatchdbViewColumnupdate/api/v1/db/meta/views/{viewId}/columns/{columnId}
MetaGetdbViewSharelist/api/v1/db/meta/views/{viewId}/share
MetaPostdbViewSharecreate/api/v1/db/meta/views/{viewId}/share
MetaPatchdbViewShareupdate/api/v1/db/meta/views/{viewId}/share
MetaDeletedbViewSharedelete/api/v1/db/meta/views/{viewId}/share
MetaGetpluginlist/api/v1/db/meta/plugins
MetaGetpluginstatus/api/v1/db/meta/plugins/{pluginTitle}/status
MetaPostplugintest/api/v1/db/meta/plugins/test
MetaPATCHpluginupdate/api/v1/db/meta/plugins/{pluginId}
MetaGetpluginread/api/v1/db/meta/plugins/{pluginId}
MetaGetprojectmetaGet/api/v1/db/meta/projects/{projectId}/info
MetaGetprojectmodelVisibilityList/api/v1/db/meta/projects/{projectId}/visibility-rules
MetaPostprojectmodelVisibilitySet/api/v1/db/meta/projects/{projectId}/visibility-rules
MetaGetprojectlist/api/v1/db/meta/projects
MetaPostprojectcreate/api/v1/db/meta/projects
MetaGetprojectread/api/v1/db/meta/projects/{projectId}
MetaDeleteprojectdelete/api/v1/db/meta/projects/{projectId}
MetaGetprojectauditList/api/v1/db/meta/projects/{projectId}/audits
MetaGetprojectmetaDiffGet/api/v1/db/meta/projects/{projectId}/meta-diff
MetaPostprojectmetaDiffSync/api/v1/db/meta/projects/{projectId}/meta-diff
MetaGetprojectsharedBaseGet/api/v1/db/meta/projects/{projectId}/shared
MetaDeleteprojectsharedBaseDisable/api/v1/db/meta/projects/{projectId}/shared
MetaPostprojectsharedBaseCreate/api/v1/db/meta/projects/{projectId}/shared
MetaPatchprojectsharedBaseUpdate/api/v1/db/meta/projects/{projectId}/shared
MetaPoststorageupload/api/v1/db/storage/upload
MetaPoststorageuploadByUrl/api/v1/db/storage/upload-by-url
MetaGetutilscommentList/api/v1/db/meta/audits/comments
MetaPostutilscommentRow/api/v1/db/meta/audits/comments
MetaGetutilscommentCount/api/v1/db/meta/audits/comments/count
MetaPostutilsauditRowUpdate/api/v1/db/meta/audits/update
MetaGetutilscacheGet/api/v1/db/meta/cache
MetaDeleteutilscacheDelete/api/v1/db/meta/cache
MetaPostutilstestConnection/api/v1/db/meta/projects/connection/test
MetaGetutilsappInfo/api/v1/db/meta/nocodb/info
MetaGetutilsappVersion/api/v1/version
MetaGetutilsappHealth/api/v1/health
MetaGetutilsaggregatedMetaInfo/api/v1/aggregated-meta-info
MetaGetorgUserslist/api/v1/users
MetaPostorgUsersadd/api/v1/users
MetaPatchorgUsersupdate/api/v1/users/{userId}
MetaDeleteorgUsersdelete/api/v1/users/{userId}
MetaGetorgTokenslist/api/v1/tokens
MetaPostorgTokenscreate/api/v1/tokens
MetaDeleteorgTokensdelete/api/v1/tokens/{token}
MetaGetorgAppSettingsget/api/v1/app-settings
MetaPostorgAppSettingsset/api/v1/app-settings

Query params​

NameAliasUse caseDefault valueExample value
wherewComplicated where conditions(colName,eq,colValue)~or(colName2,gt,colValue2)
Usage: Comparison operators
Usage: Logical operators
limitlNumber of rows to get (SQL limit value)1020
offsetoOffset for pagination (SQL offset value)020
sortsSort by column name, Use - as prefix for descending sortcolumn_name
fieldsfRequired column names in result*column_name1,column_name2
shufflerShuffle the result for pagination01 (Only allow 0 or 1. Other values would see it as 0)

Comparison Operators​

OperationMeaningExample
eqequal(colName,eq,colValue)
neqnot equal(colName,neq,colValue)
notnot equal (alias of neq)(colName,not,colValue)
gtgreater than(colName,gt,colValue)
gegreater or equal(colName,ge,colValue)
ltless than(colName,lt,colValue)
leless or equal(colName,le,colValue)
isis(colName,is,true/false/null)
isnotis not(colName,isnot,true/false/null)
inin(colName,in,val1,val2,val3,val4)
btwbetween(colName,btw,val1,val2)
nbtwnot between(colName,nbtw,val1,val2)
likelike(colName,like,%name)
isWithinis Within (Available in Date and DateTime only)(colName,isWithin,sub_op)
allofincludes all of(colName,allof,val1,val2,...)
anyofincludes any of(colName,anyof,val1,val2,...)
nallofdoes not include all of (includes none or some, but not all of)(colName,nallof,val1,val2,...)
nanyofdoes not include any of (includes none of)(colName,nanyof,val1,val2,...)

Comparison Sub-Operators​

The following sub-operators are available in Date and DateTime columns.

OperationMeaningExample
todaytoday(colName,eq,today)
tomorrowtomorrow(colName,eq,tomorrow)
yesterdayyesterday(colName,eq,yesterday)
oneWeekAgoone week ago(colName,eq,oneWeekAgo)
oneWeekFromNowone week from now(colName,eq,oneWeekFromNow)
oneMonthAgoone month ago(colName,eq,oneMonthAgo)
oneMonthFromNowone month from now(colName,eq,oneMonthFromNow)
daysAgonumber of days ago(colName,eq,daysAgo,10)
daysFromNownumber of days from now(colName,eq,daysFromNow,10)
exactDateexact date(colName,eq,exactDate,2022-02-02)

For isWithin in Date and DateTime columns, the different set of sub-operators are used.

OperationMeaningExample
pastWeekthe past week(colName,isWithin,pastWeek)
pastMonththe past month(colName,isWithin,pastMonth)
pastYearthe past year(colName,isWithin,pastYear)
nextWeekthe next week(colName,isWithin,nextWeek)
nextMonththe next month(colName,isWithin,nextMonth)
nextYearthe next year(colName,isWithin,nextYear)
nextNumberOfDaysthe next number of days(colName,isWithin,nextNumberOfDays,10)
pastNumberOfDaysthe past number of days(colName,isWithin,pastNumberOfDays,10)

Logical Operators​

OperationExample
~or(checkNumber,eq,JM555205)~or((amount, gt, 200)~and(amount, lt, 2000))
~and(checkNumber,eq,JM555205)~and((amount, gt, 200)~and(amount, lt, 2000))
~not~not(checkNumber,eq,JM555205)
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/developer-resources/sdk/index.html b/packages/noco-docs/dist/0.109.7/developer-resources/sdk/index.html index 76492a1423..ab7a350a8b 100644 --- a/packages/noco-docs/dist/0.109.7/developer-resources/sdk/index.html +++ b/packages/noco-docs/dist/0.109.7/developer-resources/sdk/index.html @@ -4,13 +4,13 @@ NocoDB SDK | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

NocoDB SDK

We provide SDK for users to integrate with their applications. Currently only SDK for Javascript is supported.

note

The NocoDB SDK requires authorization token. If you haven't created one, please check out Accessing APIs for details.

SDK For Javascript​

Install nocodb-sdk​

npm i nocodb-sdk

Import Api​

import { Api } from 'nocodb-sdk'

Configure Api​

The Api can be authorizated by either Auth Token or API Token.

Example: Auth Token​

const api = new Api({
  baseURL: 'https://<HOST>:<PORT>',
  headers: {
    'xc-auth': '<AUTH_TOKEN>'
  }
})

Example: API Token​

const api = new Api({
  baseURL: 'https://<HOST>:<PORT>',
  headers: {
    'xc-token': '<API_TOKEN>'
  }
})

Call Functions​

Once you have configured api, you can call different types of APIs by api.<Tag>.<FunctionName>.

note

For Tag and FunctionName, please check out the API table here.

Example: Calling API - /api/v1/db/meta/projects/{projectId}/tables​

await api.dbTable.create(params)
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/developer-resources/upload-via-api/index.html b/packages/noco-docs/dist/0.109.7/developer-resources/upload-via-api/index.html index b6d5b13c49..18a4c99895 100644 --- a/packages/noco-docs/dist/0.109.7/developer-resources/upload-via-api/index.html +++ b/packages/noco-docs/dist/0.109.7/developer-resources/upload-via-api/index.html @@ -4,14 +4,14 @@ Upload via API | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Upload via API

Sample code to upload files via API is listed below. Assumes http://localhost:8080/ as the base URL for the API calls.

Upload local file

let axios = require("axios").default;
let FormData = require('form-data');
let fs = require('fs');

// Configurations
//
const project_id = '<Project Identifier>';
const table_id = '<Table Identifier>';
const xc_token = '<Auth Token>';
const file_path = '<Local File Path>';


// Insert Image
// @param image_path : local file path
// @return : JSON object to be used in insert record API for attachment field
//
async function insertImage (path) {
    const formData = new FormData();
    formData.append("file", fs.createReadStream(path));
    const data = await axios({
        url: 'http://localhost:8080/api/v1/db/storage/upload',
        data: formData,
        headers:{
            'Content-Type':`multipart/form-data;`,
            'xc-auth': xc_token
        },
        method: 'post',

        // Optional : storage file path
        params: {"path": "somePath"}
    });
    return data;
}

// Insert record with attachment
// Assumes a table with two columns :
//      'Title' of type SingleLineText and
//      'Attachment' of type Attachment
//
async function uploadFileExample() {
    let response = await insertImage(file_path);

    let row = {
        "Title": "2",
        "Attachment": response.data
    };

    await axios({
        method: 'POST',
        url: `http://localhost:8080/api/v1/db/data/noco/${project_id}/${table_id}`,
        data: row,
        headers: {
            'xc-auth': xc_token
        }
    });
}

(async () => {
    await uploadFileExample();
})();

Upload via URL

let axios = require("axios").default;
let FormData = require('form-data');
let fs = require('fs');

// Configurations
//
const project_id = '<Project Identifier>';
const table_id = '<Table Identifier>';
const xc_token = '<Auth Token>';

// URL array : URLs of files to be uploaded
const URLs = [{ url: '<URL1>' }, { url: '<URL2>' }];

// Insert Image
// @param URLs : [] containing public URL for files to be uploaded
// @return : JSON object to be used in insert record API for attachment field
//
async function insertImageByURL (URL_array) {
    const data = await axios({
        url: 'http://localhost:8080/api/v1/db/storage/upload-by-url',
        data: URL_array,
        headers: {
            'xc-auth': xc_token
        },
        method: 'post',

        // Optional : storage file path
        params: {"path": "somePath"}
    });
    return data;
}

// Insert record with attachment
// Assumes a table with two columns :
//      'Title' of type SingleLineText and
//      'Attachment' of type Attachment
//
async function uploadByUrlExample() {
    let response = await insertImageByURL(URLs);

    // Update two columns : Title and Attachment
    let row = {
        "Title": "3",
        "Attachment": response.data
    };

    await axios({
        method: 'POST',
        url: `http://localhost:8080/api/v1/db/data/noco/${project_id}/${table_id}`,
        data: row,
        headers: {
            'xc-auth': xc_auth
        }
    });
}

(async () => {
    await uploadByUrlExample();
})();
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/developer-resources/webhooks/index.html b/packages/noco-docs/dist/0.109.7/developer-resources/webhooks/index.html index 26898bff7f..0d3968cb27 100644 --- a/packages/noco-docs/dist/0.109.7/developer-resources/webhooks/index.html +++ b/packages/noco-docs/dist/0.109.7/developer-resources/webhooks/index.html @@ -4,7 +4,7 @@ Webhooks | NocoDB - + @@ -13,7 +13,7 @@ For INSERT/ UPDATE based triggers, use following handlebars to access corresponding data fields.

Note that, for Update trigger - all the fields in the ROW will be accessible, not just the field updated. For DELETE based triggers, only {{ data.id }} is accessible representing ID of the column deleted.

JSON format​

Use {{ json data }} to dump complete data & user information available in JSON format

Additional references:​

Handlebar Guide.

Application Guide

Discord​

1. Create WebHook​

Screenshot 2022-02-22 at 1 21 59 PM

Screenshot 2022-02-22 at 1 23 18 PM

(Sample webhook URL: https://discord.com/api/webhooks/945558283756908644/GNUtiGuzfOky6wZ4ce30XuXc1sbPK3Od7EC-4t6hihh5Fovv6oU9OsdT6mGuoL1QlTzj).
Detailed procedure for discord webhook described here.

2. Install Plugin​

Screenshot 2022-09-14 at 10 47 59 AM

Screenshot 2022-09-14 at 10 52 14 AM

3. Configure​

Slack​

1. Create WebHook​

2. Install Plugin​

3. Configure Webhook​

Microsoft Teams​

1. Create WebHook​

154971352-6912d53b-cf71-4edd-a319-1c85be85f0c5154971434-0ced97f7-205a-4e2e-8f88-17092cb7771a- Create webhook, Copy webhook URL ![154971683-db16be7f-4f07-4447-8f2e-ac50e133bef8](https://user-images.githubusercontent.com/86527202/155095733-c339a914-5d78-408c-8f1e-9cd75a7783e8.png)

2. Install Plugin​

Screenshot 2022-09-14 at 10 53 22 AM

Screenshot 2022-09-14 at 10 53 31 AM

3. Configure​

Webhook V2​

Webhook v2 is available after v0.106.0. Here's the differences.

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/engineering/architecture/index.html b/packages/noco-docs/dist/0.109.7/engineering/architecture/index.html index 24344a86ea..2169795125 100644 --- a/packages/noco-docs/dist/0.109.7/engineering/architecture/index.html +++ b/packages/noco-docs/dist/0.109.7/engineering/architecture/index.html @@ -4,13 +4,13 @@ Architecture Overview | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Architecture Overview

By default, if NC_DB is not specified, then SQLite will be used to store your meta data. We suggest users to separate the meta data and user data in different databases.

image

Project TypeMetadata stored inData stored in
Create new projectNC_DBNC_DB
Create new project with External DatabaseNC_DBExternal Database
Create new project from ExcelNC_DBNC_DB
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/engineering/builds-and-releases/index.html b/packages/noco-docs/dist/0.109.7/engineering/builds-and-releases/index.html index dd4a94456a..0a493a2c0d 100644 --- a/packages/noco-docs/dist/0.109.7/engineering/builds-and-releases/index.html +++ b/packages/noco-docs/dist/0.109.7/engineering/builds-and-releases/index.html @@ -4,13 +4,13 @@ Releases & Builds | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Releases & Builds

Builds of NocoDB​

There are 3 kinds of docker builds in NocoDB

Below is an overview of how to make these builds and what happens behind the scenes.

Release builds​

How to make a release build ?​

  • Click NocoDB release action

  • You should see the below screen

    image

  • Change Use workflow from to Branch: master. If you choose the wrong branch, the workflow will be ended.

    image

  • Then there would be two cases - you can either leave target tag and pervious tag blank or manually input some values

  • Target Tag means the target deployment version, while Previous Tag means the latest version as of now. Previous Tag is used for Release Note only - showing the file / commit differences between two tags.

Tagging​

The naming convention would be following given the actual release tag is 0.100.0

  • 0.100.0-beta.0 (first version of pre-release)
  • 0.100.0-beta.1 (include bug fix changes on top of the previous version)
  • 0.100.0-beta.2(include bug fix changes on top of the previous version)
  • and so on ...
  • 0.100.0 (actual release)
  • 0.100.1 (minor bug fix release)
  • 0.100.2 (minor bug fix release)

Case 1: Leaving inputs blank​

  • If Previous Tag is blank, then the value will be fetched from latest
  • If Target Tag is blank, then the value will be Previous Tag plus one. Example: 0.90.11 (Previous Tag) + 0.0.1 = 0.90.12 (Target Tag)

Case 2: Manually Input​

Why? Sometimes we may mess up in NPM deployment. As NPM doesn't allow us to redeploy to the same tag again, in this case we cannot just use the previous tag + 1. Therefore, we need to use previous tag + 2 instead and we manually configure it.

  • After that, click Run workflow to start
  • You can see Summary for the overall job status.
  • Once release-draft-note and release-executables is finished, then go to releases, edit the draft note and save as draft for time being.
    • Example: Adding header, update content if necessary, and click Auto-generate release notes to include more info.
  • Once release-docker is finished, then test it locally first. You'll be expected to see Upgrade Available notification in UI as we haven't published the release note. (the version is retrieved from there)
  • Once everything is finished, then publish the release note and the deployment is considered as DONE.

How does release action work ?​

validate-branch​

To check if github.ref is master. Otherwise, other branches will be not accepted.

process-input​

To enrich target tag or previous tag if necessary.

pr-to-master​

Automate a PR from develop to master branch so that we know the actual differences between the previous tag and the current tag. We choose master branch for a deployment base.

release-npm​

Build frontend and backend and release them to NPM. The changes during built such as version bumping will be committed and pushed to a temporary branch and an automated PR will be created and merged to master branch.

Note that once you publish with a certain tag, you cannot publish with the same tag again.

release-draft-note​

Generate a draft release note. Some actions need to be done after this step.

release-docker​

Build docker image and publish it to Docker Hub. It may take around 15 - 30 mins.

close-issues​

Open issues marked with label Status: Fixed and Status: Resolved will be closed by bot automatically with comment mentioning the fix is included in which version.

Example:

image

publish-docs​

Publish Documentations

update-sdk-path​

nocodb-sdk is used in frontend and backend. However, in develop branch, the value would be file:../nocodb-sdk for development purpose (so that the changes done in nocodb-sdk in develop will be included in frontend and backend). During the deployment, the value will be changed to the target tag. This job is to update them back.

sync-to-develop​

Once the deployment is finished, there would be some new changes being pushed to master branch. This job is to sync the changes back to develop so that both branch won't have any difference.

Daily builds​

What are daily builds ?​

  • NocoDB creates every 6 hours from develop branches and publishes as nocodb/nocodb-daily
  • This is so that we can easily try what is in the develop branch easily.

Docker images​

  • The docker images will be built and pushed to Docker Hub (See nocodb/nocodb-daily for the full list).

Timely builds​

What are timely builds ?​

NocoDB has github actions which creates docker and binaries for each PR! And these can be found as a comment on the last commit of the PR.

Example shown below

  • Go to a PR and click on the comment.

    Screenshot 2023-01-23 at 15 46 36

  • Click on the link to copy the docker image and run it locally.

    Screenshot 2023-01-23 at 15 46 55

This is to

  • reduce pull request cycle time
  • allow issue reporters / reviewers to verify the fix without setting up their local machines

Docker images​

When a non-draft Pull Request is created, reopened or synchronized, a timely build for Docker would be triggered for the changes only included in the following paths.

  • packages/nocodb-sdk/**
  • packages/nc-gui/**
  • packages/nc-plugin/**
  • packages/nocodb/**

The docker images will be built and pushed to Docker Hub (See nocodb/nocodb-timely for the full list). Once the image is ready, Github bot will add a comment with the command in the pull request. The tag would be <NOCODB_CURRENT_VERSION>-pr-<PR_NUMBER>-<YYYYMMDD>-<HHMM>.

image

Executables or Binaries​

Similarly, we provide a timely build for executables for non-docker users. The source code will be built, packaged as binary files, and pushed to Github (See nocodb/nocodb-timely for the full list).

Currently, we only support the following targets:

  • node16-linux-arm64
  • node16-macos-arm64
  • node16-win-arm64
  • node16-linux-x64
  • node16-macos-x64
  • node16-win-x64

Once the executables are ready, Github bot will add a comment with the commands in the pull request.

image

NocoDB creates Docker and Binaries for each PR.

This is to

  • reduce pull request cycle time
  • allow issue reporters / reviewers to verify the fix without setting up their local machines
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/engineering/development-setup/index.html b/packages/noco-docs/dist/0.109.7/engineering/development-setup/index.html index c4fc8bab69..9799fdea46 100644 --- a/packages/noco-docs/dist/0.109.7/engineering/development-setup/index.html +++ b/packages/noco-docs/dist/0.109.7/engineering/development-setup/index.html @@ -4,13 +4,13 @@ Development Setup | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Development Setup

Clone the repo​

git clone https://github.com/nocodb/nocodb
cd nocodb/packages

Build SDK​

# build nocodb-sdk
cd nocodb-sdk
npm install
npm run build

Build Backend​

# build backend - runs on port 8080
cd ../nocodb
npm install
npm run watch:run

Build Frontend​

# build frontend - runs on port 3000
cd ../nc-gui
npm install
npm run dev

Any changes made to frontend and backend will be automatically reflected in the browser.

Enabling CI-CD for Draft PR​

CI-CD will be triggered on moving a PR from draft state to Ready for review state & on pushing changes to Develop. To verify CI-CD before requesting for review, add label trigger-CI on Draft PR.

Accessing CI-CD Failure Screenshots​

For Playwright tests, screenshots are captured on the tests. These will provide vital clues for debugging possible issues observed in CI-CD. To access screenshots, Open link associated with CI-CD run & click on Artifacts

Screenshot 2022-09-29 at 12 43 37 PM

Accessing 'Easter egg' menu​

Double click twice on empty space between View list & Share button to the left top of Grid view; following options become accessible

  1. Export Cache
  2. Delete Cache
  3. Debug Meta
  4. Toggle Beta Features

Screenshot 2023-05-23 at 8 35 14 PM

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/engineering/playwright/index.html b/packages/noco-docs/dist/0.109.7/engineering/playwright/index.html index 22dae70a23..564720f258 100644 --- a/packages/noco-docs/dist/0.109.7/engineering/playwright/index.html +++ b/packages/noco-docs/dist/0.109.7/engineering/playwright/index.html @@ -4,13 +4,13 @@ Playwright E2E Testing | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Playwright E2E Testing

How to run tests​

All the tests reside in tests/playwright folder.

Make sure to install the dependencies(in the playwright folder):

npm install
npx playwright install chromium --with-deps

Run Test Server​

Start the backend test server (in packages/nocodb folder):

npm run watch:run:playwright

Start the frontend test server (in packages/nc-gui folder):

NUXT_PAGE_TRANSITION_DISABLE=true npm run dev

Running all tests​

For selecting db type, rename .env.example to .env and set E2E_DEV_DB_TYPE to sqlite(default), mysql or pg.

headless mode(without opening browser):

npm run test

with browser:

npm run test:debug

For setting up mysql(sakila):

docker-compose -f ./tests/playwright/scripts/docker-compose-mysql-playwright.yml  up -d

For setting up postgres(sakila):

docker-compose -f ./tests/playwright/scripts/docker-compose-playwright-pg.yml

Running individual tests​

Add .only to the test you want to run:

test.only('should login', async ({ page }) => {
  // ...
})
npm run test

Concepts​

Independent tests​

  • All tests are independent of each other.
  • Each test starts with a fresh project with a fresh sakila database(option to not use sakila db is also there).
  • Each test creates a new user(email as user@nocodb.com) and logs in with that user to the dashboard.

Caveats:

  • Some stuffs are shared i.e, users, plugins etc. So be catious while writing tests touching that. A fix for this is in the works.
  • In test, we prefix email and project with the test id, which will be deleted after the test is done.

What to test​

  • UI verification. This includes verifying the state of the UI element, i.e if the element is visible, if the element has a particular text etc.
  • Test should verify all user flow. A test has a default timeout of 60 seconds. If a test is taking more than 60 seconds, it is a sign that the test should be broken down into smaller tests.
  • Test should also verify all the side effects the feature(i.e. On adding a new column type, should verify column deletion as well) will have, and also error cases.
  • Test name should be descriptive. It should be easy to understand what the test is doing by just reading the test name.

Playwright​

  • Playwright is a nodejs library for automating chromium, firefox and webkit.
  • For each test, a new browser context is created. This means that each test runs in a new incognito window.
  • For assertion always use expect from @playwright/test library. This library provides a lot of useful assertions, which also has retry logic built in.

Page Objects​

  • Page objects are used to abstract over the components/page. This makes the tests more readable and maintainable.
  • All page objects are in tests/playwright/pages folder.
  • All the test related code should be in page objects.
  • Methods should be as thin as possible and its better to have multiple methods than one big method, which improves reusability.

The methods of a page object can be classified into 2 categories:

  • Actions: Performs an UI actions like click, type, select etc. Is also responsible for waiting for the element to be ready and the action to be performed. This included waiting for API calls to complete.
  • Assertions: Asserts the state of the UI element, i.e if the element is visible, if the element has a particular text etc. Use expect from @playwright/test and if not use expect.poll to wait for the assertion to pass.

Writing a test​

Let's write a test for testing filter functionality.

For simplicity, we will have DashboardPage implemented, which will have all the methods related to dashboard page and also its child components like Grid, etc.

Create a test suite​

Create a new file filter.spec.ts in tests/playwright/tests folder and use setup method to create a new project and user.

import { test, expect } from '@playwright/test';
import setup, { NcContext } from '../setup';

test.describe('Filter', () => {
  let context: NcContext;

  test.beforeEach(async ({ page }) => {
    context = await setup({ page });
  })

  test('should filter', async ({ page }) => {
    // ...
  });
});

Create a page object​

Since filter is UI wise scoped to a Toolbar , we will add filter page object to ToolbarPage page object.

export class ToolbarPage extends BasePage {
  readonly parent: GridPage | GalleryPage | FormPage | KanbanPage;
  readonly filter: ToolbarFilterPage;

  constructor(parent: GridPage | GalleryPage | FormPage | KanbanPage) {
    super(parent.rootPage);
    this.parent = parent;
    this.filter = new ToolbarFilterPage(this);
  }
}

We will create ToolbarFilterPage page object, which will have all the methods related to filter.

export class ToolbarFilterPage extends BasePage {
  readonly toolbar: ToolbarPage;

  constructor(toolbar: ToolbarPage) {
    super(toolbar.rootPage);
    this.toolbar = toolbar;
  }
}

Here BasePage is an abstract class, which used to enforce structure for all page objects. Thus all page object should inherit BasePage.

  • Helper methods like waitForResponse and getClipboardText (this can be access on any page object, with this.waitForResponse)
  • Provides structure for page objects, enforces all Page objects to have rootPage property, which is the page object created in the test setup.
  • Enforces all pages to have a get method which will return the locator of the main container of that page, hence we can have focused dom selection, i.e.
// This will only select the button inside the container of the concerned page
await this.get().querySelector('button').count();

Writing an action method​

This a method which will reset/clear all the filters. Since this is an action method, it will also wait for the delete filter API to return. Ignoring this API call will cause flakiness in the test, down the line.

async resetFilter() {
  await this.waitForResponse({
    uiAction: () => this.get().locator('.nc-filter-item-remove-btn').click(),
    httpMethodsToMatch: ['DELETE'],
    requestUrlPathToMatch: '/api/v1/db/meta/filters/',
  });
}

Writing an assertion/verification method​

Here we use expect from @playwright/test library, which has retry logic built in.

import { expect } from '@playwright/test';

async verifyFilter({ title }: { title: string }) {
  await expect(
    this.get().locator(`[data-testid="nc-fields-menu-${title}"]`).locator('input[type="checkbox"]')
  ).toBeChecked();
}

Tips to avoid flakiness​

  • If an UI action, causes an API call or the UI state change, then wait for that API call to complete or the UI state to change.
  • What to wait out can be situation specific, but in general, is best to wait for the final state to be reached, i.e. in the case of creating filter, while it seems like waiting for the filter API to complete is enough, but after its return the table rows are reloaded and the UI state changes, so its better to wait for the table rows to be reloaded.

Accessing playwright report in the CI​

  • Open Summary tab in the CI workflow in github actions.
  • Scroll down to Artifacts section.
  • Access reports which suffixed with the db type and shard number(corresponding to the CI workerflow name). i.e playwright-report-mysql-2 is for playwright-mysql-2 workflow.
  • Download it and run npm install -D @playwright/test && npx playwright show-report ./ inside the downloaded folder.
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/engineering/repository-structure/index.html b/packages/noco-docs/dist/0.109.7/engineering/repository-structure/index.html index aad8151fa1..1854b87425 100644 --- a/packages/noco-docs/dist/0.109.7/engineering/repository-structure/index.html +++ b/packages/noco-docs/dist/0.109.7/engineering/repository-structure/index.html @@ -4,13 +4,13 @@ Repository structure | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Repository structure

We use Lerna to manage multi-packages. We have the following packages.

  • packages/nc-cli : A CLI to create NocoDB app.

  • packages/nocodb-sdk: API client sdk of nocodb.

  • packages/nc-gui: NocoDB Frontend.

  • packages/nc-lib-gui: The build version of nc-gui which will be used in packages/nocodb.

  • packages/nc-plugin: Plugin template.

  • packages/noco-blog: NocoDB Blog which will be auto-released to nocodb/noco-blog.

  • packages/noco-docs: NocoDB Documentation which will be auto-released to nocodb/noco-docs.

  • packages/nocodb: NocoDB Backend, hosted in NPM.

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/engineering/translation/index.html b/packages/noco-docs/dist/0.109.7/engineering/translation/index.html index 0b12ef38d6..878f50c6d5 100644 --- a/packages/noco-docs/dist/0.109.7/engineering/translation/index.html +++ b/packages/noco-docs/dist/0.109.7/engineering/translation/index.html @@ -4,7 +4,7 @@ i18n translation | NocoDB - + @@ -12,7 +12,7 @@
Skip to main content
Version: 0.109.7 - Old UI

i18n translation

  • NocoDB supports 30+ foreign languages & community contributions are now simplified via Crowdin.

How to add / edit translations ?​

Using Github​

  • For English, make changes directly to en.json & commit to develop
  • For any other language, use crowdin option.

Using Crowdin​

Screenshot 2022-09-08 at 10 26 23 PM

  • Click the language that you wish to contribute

Screenshot 2022-09-08 at 10 29 56 PM

  • Click the Translate button; this opens up Crowdin Online Editor

Screenshot 2022-09-08 at 10 32 17 PM

  • Select string in English on the left-hand menu bar [1]
  • Propose changes [2]
  • Save [3] Note: Crowdin provides translation recommendation's as in [4]. Click directly if it's apt

Screenshot 2022-09-08 at 10 37 38 PM

A GitHub Pull Request will be automatically triggered (periodicity- 6 hours). We will follow up on remaining integration work items.

Reference​

Refer following articles to get additional details about Crowdin Portal usage

How to add a new language ?​

GitHub changes​

  • Update enumeration in enums.ts [packages/nc-gui/lib/enums.ts]
  • Map JSON path in a.i18n.ts [packages/nc-gui/plugins/a.i18n.ts]

Crowdin changes [admin only]​

  • Open NocoDB project
  • Click on Language on the home tab
  • Select target language, Update
  • Update array in tests/playwright/tests/language.spec.ts

Screenshot 2022-09-08 at 10 52 59 PM

Screenshot 2022-09-08 at 10 54 04 PM

String Categories​

  • General: simple & common tokens (save, cancel, submit, open, close, home, and such)
  • Objects: objects from NocoDB POV (project, table, field, column, view, page, and such)
  • Title: screen headers (compact) (menu headers, modal headers)
  • Lables: text box/ radio/ field headers (few words) (Labels over textbox, radio buttons, and such)
  • Activity/ actions: work items (few words) (Create Project, Delete Table, Add Row, and such)
  • Tooltip: additional information associated with work items (usually lengthy) (Additional information provided for activity)
  • Placeholder: placeholders associated with various textboxes (Text placeholders)
  • Msg
    • Info: general/success category for everything
    • Error: warnings & errors
    • Toast: pop-up toast messages

Note: string name should be in camelCase. Use above list as priority order in case of ambiguity.

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/engineering/unit-testing/index.html b/packages/noco-docs/dist/0.109.7/engineering/unit-testing/index.html index 0868103ba0..3b65bb4600 100644 --- a/packages/noco-docs/dist/0.109.7/engineering/unit-testing/index.html +++ b/packages/noco-docs/dist/0.109.7/engineering/unit-testing/index.html @@ -4,7 +4,7 @@ Writing Unit Tests | NocoDB - + @@ -13,7 +13,7 @@ DB_PORT : port DB_USER : username DB_PASSWORD : password

Run Tests​

npm run test:unit

Folder Structure​

The root folder for unit tests is packages/nocodb/tests/unit

Factory Pattern​

Walk through of writing a Unit Test​

We will create an Table test suite as an example.

Configure test​

We will configure beforeEach which is called before each test is executed. We will use init function from nocodb/packages/nocodb/tests/unit/init/index.ts, which is a helper function which configures the test environment(i.e resetting state, etc.).

init does the following things -

We will use createProject and createProject factories to create a project and a table.

let context;

beforeEach(async function () {
  context = await init();

  project = await createProject(context);
  table = await createTable(context, project);
});

Test case​

We will use it function to create a test case. We will use supertest to make a request to the server. We use expect(chai) to assert the response.

it('Get table list', async function () {
  const response = await request(context.app)
    .get(`/api/v1/db/meta/projects/${project.id}/tables`)
    .set('xc-auth', context.token)
    .send({})
    .expect(200);

  expect(response.body.list).to.be.an('array').not.empty;
});
note

We can also run individual test by using .only in describe or it function and the running the test command.

it.only('Get table list', async () => {

Integrating the New Test Suite​

We create a new file table.test.ts in packages/nocodb/tests/unit/rest/tests directory.

import 'mocha';
import request from 'supertest';
import init from '../../init';
import { createTable, getAllTables } from '../../factory/table';
import { createProject } from '../../factory/project';
import { defaultColumns } from '../../factory/column';
import Model from '../../../../src/lib/models/Model';
import { expect } from 'chai';

function tableTest() {
  let context;
  let project;
  let table;

  beforeEach(async function () {
    context = await init();

    project = await createProject(context);
    table = await createTable(context, project);
  });

  it('Get table list', async function () {
    const response = await request(context.app)
      .get(`/api/v1/db/meta/projects/${project.id}/tables`)
      .set('xc-auth', context.token)
      .send({})
      .expect(200);

    expect(response.body.list).to.be.an('array').not.empty;
  });
}

export default function () {
  describe('Table', tableTests);
}

We can then import the Table test suite to Rest test suite in packages/nocodb/tests/unit/rest/index.test.ts file(Rest test suite is imported in the root test suite file which is packages/nocodb/tests/unit/index.test.ts).

Seeding Sample DB (Sakila)​


function tableTest() {
  let context;
  let sakilaProject: Project;
  let customerTable: Model;

  beforeEach(async function () {
    context = await init();
    
    /******* Start : Seeding sample database **********/
    sakilaProject = await createSakilaProject(context);
    /******* End : Seeding sample database **********/
    
    customerTable = await getTable({project: sakilaProject, name: 'customer'})
  });

  it('Get table data list', async function () {
    const response = await request(context.app)
      .get(`/api/v1/db/data/noco/${sakilaProject.id}/${customerTable.id}`)
      .set('xc-auth', context.token)
      .send({})
      .expect(200);

    expect(response.body.list[0]['FirstName']).to.equal('MARY');
  });
}
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/getting-started/demos/index.html b/packages/noco-docs/dist/0.109.7/getting-started/demos/index.html index ff44d2a7b3..8d5a753a9a 100644 --- a/packages/noco-docs/dist/0.109.7/getting-started/demos/index.html +++ b/packages/noco-docs/dist/0.109.7/getting-started/demos/index.html @@ -4,13 +4,13 @@ Demos | NocoDB - +
Skip to main content
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/getting-started/environment-variables/index.html b/packages/noco-docs/dist/0.109.7/getting-started/environment-variables/index.html index 3c9a56ce57..462f6c8d58 100644 --- a/packages/noco-docs/dist/0.109.7/getting-started/environment-variables/index.html +++ b/packages/noco-docs/dist/0.109.7/getting-started/environment-variables/index.html @@ -4,13 +4,13 @@ Environment Variables | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Environment Variables

For production usecases, it is recommended to configure

  • NC_DB,
  • NC_AUTH_JWT_SECRET,
  • NC_PUBLIC_URL,
  • NC_REDIS_URL
VariableCommentsIf absent
NC_DBSee our database URLsA local SQLite will be created in root folder if NC_DB is not provided
NC_DB_JSONCan be used instead of NC_DB and value should be valid knex connection JSON
NC_DB_JSON_FILECan be used instead of NC_DB and value should be a valid path to knex connection JSON
DATABASE_URLJDBC URL Format. Can be used instead of NC_DB.
DATABASE_URL_FILECan be used instead of DATABASE_URL: path to file containing JDBC URL Format.
NC_AUTH_JWT_SECRETJWT secret used for auth and storing other secretsA random secret will be generated
PORTFor setting app running port8080
DB_QUERY_LIMIT_DEFAULTDefault pagination limit25
DB_QUERY_LIMIT_MAXMaximum allowed pagination limit1000
DB_QUERY_LIMIT_MINMinimum allowed pagination limit1
NC_TOOL_DIRApp directory to keep metadata and app related filesDefaults to current working directory. In docker maps to /usr/app/data/ for mounting volume.
NC_PUBLIC_URLUsed for sending Email invitationsBest guess from http request params
NC_JWT_EXPIRES_INJWT token expiry time10h
NC_CONNECT_TO_EXTERNAL_DB_DISABLEDDisable Project creation with external database
NC_INVITE_ONLY_SIGNUPRemoved since version 0.99.0 and now it's recommended to use super admin settings menu. Allow users to signup only via invite url, value should be any non-empty string.
NUXT_PUBLIC_NC_BACKEND_URLCustom Backend URLhttp://localhost:8080 will be used
NC_REQUEST_BODY_SIZERequest body size limit1048576
NC_EXPORT_MAX_TIMEOUTAfter NC_EXPORT_MAX_TIMEOUT csv gets downloaded in batchesDefault value 5000(in millisecond) will be used
NC_DISABLE_TELEDisable telemetry
NC_DASHBOARD_URLCustom dashboard url path/dashboard
NC_GOOGLE_CLIENT_IDGoogle client id to enable google authentication
NC_GOOGLE_CLIENT_SECRETGoogle client secret to enable google authentication
NC_MIGRATIONS_DISABLEDDisable NocoDB migration
NC_MINIf set to any non-empty string the default splash screen(initial welcome animation) and matrix screensaver will disable
NC_SENTRY_DSNFor Sentry monitoring
NC_REDIS_URLCustom Redis URL. Example: redis://:authpassword@127.0.0.1:6380/4Meta data will be stored in memory
NC_DISABLE_ERR_REPORTDisable error reporting
NC_DISABLE_CACHETo be used only while debugging. On setting this to true - meta data be fetched from db instead of redis/cache.false
AWS_ACCESS_KEY_IDFor Litestream - S3 access key idIf Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
AWS_SECRET_ACCESS_KEYFor Litestream - S3 secret access keyIf Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
AWS_BUCKETFor Litestream - S3 bucketIf Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
AWS_BUCKET_PATHFor Litestream - S3 bucket path (like folder within S3 bucket)If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
NC_SMTP_FROMFor SMTP plugin - Email sender address
NC_SMTP_HOSTFor SMTP plugin - SMTP host value
NC_SMTP_PORTFor SMTP plugin - SMTP port value
NC_SMTP_USERNAMEFor SMTP plugin (Optional) - SMTP username value for authentication
NC_SMTP_PASSWORDFor SMTP plugin (Optional) - SMTP password value for authentication
NC_SMTP_SECUREFor SMTP plugin (Optional) - To enable secure set value as true any other value treated as false
NC_SMTP_IGNORE_TLSFor SMTP plugin (Optional) - To ignore tls set value as true any other value treated as false. For more info visit https://nodemailer.com/smtp/
NC_S3_BUCKET_NAMEFor S3 storage plugin - AWS S3 bucket name
NC_S3_REGIONFor S3 storage plugin - AWS S3 region
NC_S3_ACCESS_KEYFor S3 storage plugin - AWS access key credential for accessing resource
NC_S3_ACCESS_SECRETFor S3 storage plugin - AWS access secret credential for accessing resource
NC_ADMIN_EMAILFor updating/creating super admin with provided email and password
NC_ATTACHMENT_FIELD_SIZEFor setting the attachment field size(in Bytes)Defaults to 20MB
NC_ADMIN_PASSWORDFor updating/creating super admin with provided email and password. Your password should have at least 8 letters with one uppercase, one number and one special letter(Allowed special chars $&+,:;=?@#|'.^*()%!_-" )
NODE_OPTIONSFor passing Node.js options to instance
NC_MINIMAL_DBSCreate a new SQLite file for each project. All the db files are stored in nc_minimal_dbs folder in current working directory. (This option restricts project creation on external sources)
NC_DISABLE_AUDITDisable Audit Logfalse
NC_AUTOMATION_LOG_LEVELPossible Values: OFF, ERROR, ALL. See Webhooks for details.OFF
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/getting-started/installation/index.html b/packages/noco-docs/dist/0.109.7/getting-started/installation/index.html index 735a466e65..a74919b664 100644 --- a/packages/noco-docs/dist/0.109.7/getting-started/installation/index.html +++ b/packages/noco-docs/dist/0.109.7/getting-started/installation/index.html @@ -4,7 +4,7 @@ Installation | NocoDB - + @@ -14,7 +14,7 @@

GCP (Cloud Run)​

Click to Expand

Pull NocoDB Image on Cloud Shell​

Since Cloud Run only supports images from Google Container Registry (GCR) or Artifact Registry, we need to pull NocoDB image, tag it and push it in GCP using Cloud Shell. Here are some sample commands which you can execute in Cloud Shell.

# pull latest NocoDB image
docker pull nocodb/nocodb:latest

# tag the image
docker tag nocodb/nocodb:latest gcr.io/<MY_PROJECT_ID>/nocodb/nocodb:latest

# push the image to GCR
docker push gcr.io/<MY_PROJECT_ID>/nocodb/nocodb:latest

Deploy NocoDB on Cloud Run​

gcloud run deploy --image=gcr.io/<MY_PROJECT_ID>/nocodb/nocodb:latest \
                  --region=us-central1 \
                  --allow-unauthenticated \
                  --platform=managed

DigitalOcean (App)​

Click to Expand

Create Apps​

On Home page, Click on Create icon & Select Apps (Deploy your code).

Screenshot 2022-02-19 at 12 17 43 PM

Choose Source: Docker Hub​

Screenshot 2022-02-19 at 12 22 01 PM

Choose Source: Repository​

Configure Source Repository as nocodb/nocodb. Optionally you can pick release tag if you are interested in specific NocoDB version.

Screenshot 2022-02-19 at 12 23 11 PM

[Optional] Additional Configurations​

Screenshot 2022-02-19 at 12 24 44 PM

Name your web service​

Pick a name for your NocoDB application. This name will become part of URL subsequently Pick nearest Region for cloud hosting Screenshot 2022-02-19 at 12 28 11 PM

Finalize and Launch​

Cloudron​

Click to Expand

Log into Cloudron and select App Store

image

Search NocoDB​

image

Click Install​

image

Configure NocoDB​

image

Go to My App and Launch NocoDB​

image

CapRover​

Click to Expand

Login and Click One-Click Apps / Databases​

image

Search NocoDB​

image

Configure NocoDB and Deploy​

image

Railway​

Click to Expand

Go to Templates, Search NocoDB and click Deploy

image

Configure NocoDB and Deploy​

image

FreeBSD / FreeNAS / TrueNAS Jail​

See here provided by C. R. Zamana.

Sample Demos​

Code Sandbox​

Docker deploying with one command​

Using NPX​

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/getting-started/upgrading/index.html b/packages/noco-docs/dist/0.109.7/getting-started/upgrading/index.html index 6fae42dedb..af5aa62f92 100644 --- a/packages/noco-docs/dist/0.109.7/getting-started/upgrading/index.html +++ b/packages/noco-docs/dist/0.109.7/getting-started/upgrading/index.html @@ -4,13 +4,13 @@ Upgrading | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Upgrading

By default, if NC_DB is not specified upon installation, then SQLite will be used to store metadata. We suggest users to separate the metadata and user data in different databases as pictured in our architecture.

Docker​

Find, Stop & Delete NocoDB Docker Container​

# find NocoDB container ID
docker ps
# stop NocoDB container
docker stop <YOUR_CONTAINER_ID>
# delete NocoDB container
docker rm <YOUR_CONTAINER_ID>

Note: Deleting your docker container without setting NC_DB or mounting to a persistent volume for a default SQLite database will result in losing your data. See examples below.

Find & Remove NocoDB Docker Image​

# find NocoDB image
docker images
# delete NocoDB image
docker rmi <YOUR_IMAGE_ID>

Pull the latest NocoDB image with same environment variables​

docker run -d -p 8080:8080 \
    -e NC_DB="<YOUR_NC_DB_URL>" \
    -e NC_AUTH_JWT_SECRET="<YOUR_NC_AUTH_JWT_SECRET_IF_GIVEN>" \
    nocodb/nocodb:latest

Updating nocodb docker container is similar to updating any other docker containers.

Example: Docker Upgrade​

Screen Shot 2021-09-16 at 09 23 07

Node​

Updating docker container is similar to updating a npm package.

From your root folder

Uninstall NocoDB package​

npm uninstall nocodb

Install NocoDB package​

npm install --save nocodb

Homebrew​

Run following commands to upgrade Homebrew Nocodb version.

# Update the local homebrew formulas
brew update
# Upgrade nocodb package
brew upgrade nocodb
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/index.html b/packages/noco-docs/dist/0.109.7/index.html index 2ff0bc4d05..16dbc39fe9 100644 --- a/packages/noco-docs/dist/0.109.7/index.html +++ b/packages/noco-docs/dist/0.109.7/index.html @@ -4,13 +4,13 @@ Welcome | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Welcome

Welcome!​

image

NocoDB is a no-code database platform that allows teams to collaborate and build applications with ease of a familiar and intuitive spreadsheet interface. This allows even non-developers or business users to become software creators.

NocoDB works by connecting to any relational database and transforming them into a smart spreadsheet interface! This allows you to build no-code applications collaboratively with teams. NocoDB currently works with MySQL, PostgreSQL, Microsoft SQL Server, SQLite, Amazon Aurora & MariaDB databases.

Also NocoDB's app store allows you to build business workflows on views with combination of Slack, Microsoft Teams, Discord, Twilio, Whatsapp, Email & any 3rd party APIs too. Plus NocoDB provides programmatic access to APIs so that you can build integrations with Zapier / Integromat and custom applications too.

Features​

Rich Spreadsheet Interface​

  • ⚡  Basic Operations: Create, Read, Update and Delete on Tables, Columns, and Rows
  • ⚡  Fields Operations: Sort, Filter, Hide / Unhide Columns
  • ⚡  Multiple Views Types: Grid (By default), Gallery, Form View and Kanban View
  • ⚡  View Permissions Types: Collaborative Views, & Locked Views
  • ⚡  Share Bases / Views: either Public or Private (with Password Protected)
  • ⚡  Variant Cell Types: ID, LinkToAnotherRecord, Lookup, Rollup, SingleLineText, Attachement, Currency, Formula and etc
  • ⚡  Access Control with Roles : Fine-grained Access Control at different levels
  • ⚡  and more ...

App Store for Workflow Automations​

We provide different integrations in three main categories. See App Store for details.

  • ⚡  Chat : Slack, Discord, Mattermost, and etc
  • ⚡  Email : AWS SES, SMTP, MailerSend, and etc
  • ⚡  Storage : AWS S3, Google Cloud Storage, Minio, and etc

Programmatic Access​

We provide the following ways to let users to invoke actions in a programmatic way. You can use a token (either JWT or Social Auth) to sign your requests for authorization to NocoDB.

  • ⚡  REST APIs
  • ⚡  NocoDB SDK

Sync Schema​

We allow you to sync schema changes if you have made changes outside NocoDB GUI. However, it has to be noted then you will have to bring your own schema migrations for moving from environment to others. See Sync Schema for details.

Audit​

We are keeping all the user operation logs under one place. See Audit for details.

Why are we building this?​

Most internet businesses equip themselves with either spreadsheet or a database to solve their business needs. Spreadsheets are used by a Billion+ humans collaboratively every single day. However, we are way off working at similar speeds on databases which are way more powerful tools when it comes to computing. Attempts to solve this with SaaS offerings has meant horrible access controls, vendor lockin, data lockin, abrupt price changes & most importantly a glass ceiling on what's possible in future.

Our Mission​

Our mission is to provide the most powerful no-code interface for databases which is open source to every single internet business in the world. This would not only democratise access to a powerful computing tool but also bring forth a billion+ people who will have radical tinkering-and-building abilities on internet.

How can I contribute to NocoDB's development ?​

Please refer to here for the contribution guidelines.

Where can I join the NocoDB community?​

Follow us for daily updates, content, and other activities with our community:

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/account-settings/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/account-settings/index.html index 7aeee23e4c..e56930a392 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/account-settings/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/account-settings/index.html @@ -4,7 +4,7 @@ Account Settings | NocoDB - + @@ -12,7 +12,7 @@
Skip to main content
Version: 0.109.7 - Old UI

Account Settings

Overview​

Account Settings allow you to manage your account such as your password or tokens.

image

Reset Password​

image

Token Management​

  • Newly created tokens are associated with the created user and it will have all permissions that particular user has.
  • Existing token will work as it is and only be visible to the super admin.
image

If you are a super admin, you can also manage all user roles in organization level.

User Management​

Permissions within NocoDB are divided into two levels: Organisation level and Project level.

Organisation Level Permissions:​

  • Org Level Creator: Allows users to create new projects and access invited projects.
  • Org Level Viewer: Allows users to access invited projects but does not permit the creation of new projects.

image

Project Level Permissions:​

  • Owner: The user who created the project. A project can have only one owner. The owner persists until the project exists and the role is non-transferable. The owner has access to carry out any operations within the project, including deleting it.
  • Creator: Has access to carry out any operations within the project except deleting the project and removing the "Owner."
  • Editor: Can modify data but cannot modify the schema (add/remove columns, tables, users, and such).
  • Commenter: Can neither modify data nor schema, can only see data and can mark row-level comments.
  • Viewer: Can only see data.

Additional access details for project level permissions can be found here. Please note that the above-mentioned Project Level Permissions are additional to the already defined Organisation Level Permissions. In addition to the previously defined permissions, NocoDB also includes the role of "Super Admin." The "Super Admin" is the first user to sign up on this NocoDB installation. An organisation can have only one "Super Admin" and this role is non-transferable. The "Super Admin" will have the equivalent permissions of an "Org Level Creator" and "Owner" for all projects within the organisation.

Enable / Disable Signup​

Signup without an invitation is disabled by default and can be managed from UI by a super admin.

image

App Store​

image

We provide different integrations in three main categories.

CategoryApp Name
ChatMicrosoft Teams
Discord
Twilio
Whatsapp Twilio
Mattermost
Slack
EmailSMTP
MailerSend
AWS SES
StorageAWS S3
Minio
Google Cloud Storage
Spaces
Backblaze B2
Vultr Object Storage
OvhCloud Object Storage
Linode Object Storage
UpCloud Object Storage
Scaleway Object Storage

License​

You can configure NocoDB Enterprise License key here

Screenshot 2023-01-12 at 2 30 57 PM

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/audit/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/audit/index.html index 7b7a2af591..662f04816c 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/audit/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/audit/index.html @@ -4,13 +4,13 @@ Audit | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Audit

Overview​

We are keeping all the user operation logs under Audit. To access it, click the down arrow button next to Project Name on the top left side, then select Team & Settings.

info

We can disable audit logs by setting NC_DISABLE_AUDIT to true.

image

Then, under SETTINGS, click Audit.

image
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/code-snippets/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/code-snippets/index.html index 99de43a24f..2c6ba16a47 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/code-snippets/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/code-snippets/index.html @@ -4,13 +4,13 @@ Code Snippets | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Code Snippets

Overview​

In the table toolbar, click Table name button and click Get API Snippet.

image

A modal box will be shown with sample code snippet for List API.

image

Supported Snippet​

Shell​

  • cURL
  • wget

Javascript​

  • Axios
  • Fetch
  • jQuery
  • XHR

Node​

  • Axios
  • Fetch
  • Request
  • Native
  • Unirest

NocoDB SDK​

  • Javascript
  • Node

PHP​

Python​

  • http.client
  • request

Ruby​

Java​

C​

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/column-operations/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/column-operations/index.html index 8df8eddc25..c997d22f74 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/column-operations/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/column-operations/index.html @@ -4,13 +4,13 @@ Column Operations | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Column Operations

Fields​

Click Fields to control the visibility of a field.

image

By default, all system fields will be hid. However, you can tick Show system fields to make them visible.

image

Re-order Columns​

Column positions can be re-ordered. Open Fields menu, and re-order fields as needed by dragging and dropping the drag icon.

image

Hide / Unhide Columns​

To hide / unhide columns, open Fields menu, tick checkbox to keep the column visible, untick checkbox to remove it from the view.

tip

You can create different grid views with different fields shown in each view.

image

Sort​

Sorting allows you to order contents alphabetically (A → Z) / (Z → A) (OR) in ascending / descending order. NocoDB allows nested sorting. You can choose column fields & order in which to apply nested sorting. Lookup, Formula, Nested Data are also supported in Sorting.

imageimageimage

Filter​

Filters allow you to restrict / organize your data on the view as per your needs. NocoDB allows nested filters. You can choose multiple columns and conditions to apply filter. Between filters, you can opt for either and or or mode operation. Lookup, Formula, Nested Data are also supported in Filtering.

imageimage

You can also group several filters together using Filter Group.

image

Enable NULL and EMPTY Filters​

NULL filters (is null & is not null) and EMPTY filters (is empty & is not empty) are hidden by default. If you wish to filter out either one only, you may enable Show NULL and EMPTY Filter in Project Settings.

image

Otherwise, we can use Blank filters to filter out cells with NULL values and EMPTY values.

Supported Filters​

Currently we support different types of filters for corresponding columns. Please refer the below matrix for details.

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/column-types/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/column-types/index.html index 8c0966cc68..66663f09d6 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/column-types/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/column-types/index.html @@ -4,7 +4,7 @@ Column Types | NocoDB - + @@ -12,7 +12,7 @@
Skip to main content
Version: 0.109.7 - Old UI

Column Types

Available Column Types​

TypeDescription
LinkToAnotherRecordHas Many or Many To Many columns
SingleLineTextFor short text
LongTextFor lengthy string content
AttachmentFile attachment column
CheckboxBoolean value
MultiSelectMultiple options can be selected once
SingleSelectSingle option select
DateDate selector
YearYear selector
TimeTime selector
PhoneNumberPhone number field
EmailEmail field
URLValid URL field
NumberAny type of number
DecimalFractional number
CurrencyCurrency value
PercentPercentage
DurationDuration
RatingRating
FormulaFormula based generated column
RollupPerforms calculations and aggregations
DateTimeDate & Time selector
QR CodeQR Code visualization of another referenced column
BarcodeBarcode visualization of another referenced column
GeometryGeometry column
GeoDataGeoData column
JsonJson column
SpecificDBTypeCustom DB type option

Database Types​

LinkToAnotherRecord​

For more about Link To Another Record, please visit here.

SingleLineText​

Available Database Types​

DatabaseTypesDefault Type
MySQLchar, varchar, nchar, text, tinytext, mediumtext, longtextvarchar
PostgreSQLchar, character, character varying, textcharacter varying
SQL Serverchar, ntext, text, varchar, nvarcharvarchar
SQLitecharacter, text, varcharvarchar

LongText​

Available Database Types​

DatabaseTypesDefault Type
MySQLchar, varchar, nchar, text, tinytext, mediumtext, longtexttext
PostgreSQLchar, character, character varying, texttext
SQL Serverchar, ntext, text, varchar, nvarchartext
SQLitecharacter, text, varchartext

Attachment​

Available Database Types​

DatabaseTypesDefault Type
MySQLjson, char, varchar, nchar, text, tinytext, mediumtext, longtexttext
PostgreSQLjson, char, character, character varying, texttext
SQL Serverchar, ntext, text, varchar, nvarchartext
SQLitecharacter, text, varchartext

Checkbox​

Available Database Types​

DatabaseTypesDefault Type
MySQLint, smallint, mediumint, bigint, bit, boolean, serial, tinyinttinyint
PostgreSQLbit, bool, int2, int4, int8, boolean, smallint, int, integer, bigint, bigserial, char, int4range, int8range, serial, serial2, serial8bool
SQL Serverbigint, bit, int, tinyinttinyint
SQLiteint, integer, tinyint, smallint, mediumint, bigint, int2, int8, boolean

MultiSelect​

Available Database Types​

DatabaseTypesDefault Type
MySQLset, text, tinytext, mediumtext, longtextset
PostgreSQLtexttext
SQL Servertext, ntexttext
SQLitetext, varchartext

SingleSelect​

Available Database Types​

DatabaseTypesDefault Type
MySQLenum, text, tinytext, mediumtext, longtextenum
PostgreSQLtexttext
SQL Servertext, ntexttext
SQLitetext, varchartext

Date​

Available Database Types​

DatabaseTypesDefault Type
MySQLdate, datetime, timestamp, varcharvarchar
PostgreSQLdate, timestamp, timestamp without time zone, timestamptz, timestamp with time zone
SQL Serverdatedate
SQLitedate, varcharvarchar

Year​

Available Database Types​

DatabaseTypesDefault Type
MySQLyearyear
PostgreSQLintint
SQL Serverintint
SQLiteint, integer, tinyint, smallint, mediumint, bigint, int2, int8year

Time​

Available Database Types​

DatabaseTypesDefault Type
MySQLtimetime
PostgreSQLtime, time without time zone, timestamp, timestamp without time zone, timestamptz, timestamp with time zone, timetz, time with time zonetime
SQL Servertimetime
SQLiteint, integer, tinyint, smallint, mediumint, bigint, int2, int8time

PhoneNumber​

Available Database Types​

DatabaseTypesDefault Type
MySQLvarcharvarchar
PostgreSQLcharacter varyingcharacter varying
SQL Servervarcharvarchar
SQLitevarchar, textvarchar

Email​

Available Database Types​

DatabaseTypesDefault Type
MySQLvarcharvarchar
PostgreSQLcharacter varyingcharacter varying
SQL Servervarcharvarchar
SQLitevarchar, textvarchar

URL​

Available Database Types​

DatabaseTypesDefault Type
MySQLtext, tinytext, mediumtext, longtext, varcharvarchar
PostgreSQLcharacter varying, textcharacter varying
SQL Servervarchar, textvarchar
SQLitevarchar, textvarchar

Number​

Available Database Types​

DatabaseTypesDefault Type
MySQLint, smallint, mediumint, bigint, bit, float, decimal, double, serialint
PostgreSQLint, integer, bigint, bigserial, int2, int4, int8, serial, serial2, serial8, double precision, float4, float8, smallint, smallserialint8
SQL Serverint, bigint, bit, decimal, float, numeric, real, smallint, tinyintint
SQLiteint, integer, tinyint, smallint, mediumint, bigint, int2, int8, numeric, real, double, double precision, floatinteger

Decimal​

Available Database Types​

DatabaseTypesDefault Type
MySQLfloat, decimal, double, serialdecimal
PostgreSQLdouble precision,float4,float8decimal
SQL Serverdecimal, floatdecimal
SQLitereal, double, double precision, float, numericdecimal

Currency​

Available Database Types​

DatabaseTypesDefault Type
MySQLdecimal, float, double, serial', 'int, smallint, mediumint, bigint, bitdecimal
PostgreSQLint, integer, bigint, bigserial, int2, int4, int8, serial, serial2, serial8, double precision, money', 'float4, float8decimal
SQL Serverint, bigint, bit, decimal, float, numeric, real, smallint, tinyintdecimal
SQLitereal, double, double precision, float, int, integer, tinyint, smallint, mediumint, bigint, int2, int8, numericdouble precision

Percent​

Available Database Types​

DatabaseTypesDefault Type
MySQLdecimal, float, double, serial', 'int, smallint, mediumint, bigint, bitdouble
PostgreSQLint, integer, bigint, bigserial, int2, int4, int8, serial, serial2, serial8, double precision, float4, float8, smallint, smallserialdouble
SQL Serverint, bigint, bit, decimal, float, numeric, real, smallint, tinyintdouble
SQLitereal, double, double precision, float, int, integer, tinyint, smallint, mediumint, bigint, int2, int8, numericdouble

Duration​

Available Database Types​

DatabaseTypesDefault Type
MySQLdecimal, float, double, serial', 'int, smallint, mediumint, bigint, bitint
PostgreSQLint, integer, bigint, bigserial, int2, int4, int8, serial, serial2, serial8, double precision, float4, float8, smallint, smallserialint8
SQL Serverint, bigint, bit, decimal, float, numeric, real, smallint, tinyintint
SQLiteint, integer, tinyint, smallint, mediumint, bigint, int2, int8integer

Rating​

Available Database Types​

DatabaseTypesDefault Type
MySQLdecimal, float, double, serial', 'int, smallint, mediumint, bigint, bitfloat
PostgreSQLint, integer, bigint, bigserial, int2, int4, int8, serial, serial2, serial8, double precision, float4, float8, smallint, smallserialfloat8
SQL Serverint, bigint, bit, decimal, float, numeric, real, smallint, tinyintfloat
SQLitereal, double, double precision, float, int, integer, tinyint, smallint, mediumint, bigint, int2, int8, numericfloat

Formula​

For more about Formulas, please visit here.

QR-Code​

Encodes the value of a reference column as QR code. The following column types are supported for the for reference column:

  • Formula
  • Single Line Text
  • Long Text
  • Phone Number
  • URL
  • Email

Since it's a virtual column, the cell content (QR code) cannot be changed directly.

Barcode​

Encodes the value of a reference column as Barcode. Supported barcode formats: CODE128, EAN, EAN-13, EAN-8, EAN-5, EAN-2, UPC (A), CODE39, ITF-14, MSI, Pharmacode, Codabar. The following column types are supported for the for reference column:

  • Formula
  • Single Line Text
  • Long Text
  • Phone Number
  • URL
  • Email

Since it's a virtual column, the cell content (Barcode) cannot be changed directly.

Rollup​

For more about Rollup, please visit here.

DateTime​

Available Database Types​

DatabaseTypesDefault Type
MySQLdatetime, timestamp, varchardatetime
PostgreSQLtimestamp, timestamp without time zone, timestamptz, timestamp with time zonedatetime
SQL Serverdatetime, datetime2, datetimeoffsetdatetime
SQLitedatetime, timestampdatetime

Geometry​

Available Database Types​

DatabaseTypes
MySQLgeometry, point, linestring, polygon, multipoint, multilinestring, multipolygon
PostgreSQLpolygon, point, circle, box, line, lseg, path, circle
SQL Servergeometry
SQLitetext

GeoData​

Encodes a geographic location which consists of a latitude and a longitude. Both are internally stored as one string, where latitude and longitude are separated by ';' Example: "52.2134;29.1442"

Available Database Types​

DatabaseTypes
MySQLchar, varchar, nchar, text, tinytext, mediumtext, longtext
PostgreSQLchar, character, character varying, text
SQL Serverdecimal, float
SQLitecharacter, text, varchar

JSON​

Available Database Types​

DatabaseTypes
MySQLjson
PostgreSQLjson
SQL Servertext, ntext
SQLitetext

SpecificDBType​

Available Database Types​

DatabaseTypes
MySQLAll types are available
PostgreSQLAll types are available
SQL ServerAll types are available
SQLiteAll types are available
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/dashboard/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/dashboard/index.html index f575ce4c2e..03b7498509 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/dashboard/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/dashboard/index.html @@ -4,13 +4,13 @@ Dashboard | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Dashboard

Setup Your First Super Admin​

Once you have started NocoDB, you can visit the dashboard via example.com. You will be redirected to example.com/#/signup.

Enter your work email and your password.

image
note

Your password has at least 8 letters. No other constraints on case, numbers or special characters.

Initialize Your First Project​

Once you have logged into NocoDB, you should see My Projects.

Screenshot 2022-12-29 at 2 54 43 PM

To create a new project, you can click New Project.

You need to specify the project name. The data will be stored in NC_DB. If it is not specified, a local SQLite will be created and used.

note

NC_DB is an environment variable used to store the meta data in the given database.

Screenshot 2022-12-29 at 2 54 57 PM

Connecting to External Database​

Click on three-dot menu adjacent to BASES. Pick required database option from the menu Connect to new datasource.

tip

If you are running NocoDB on Docker and your local DB is running on your host machine, your Host Address would be host.docker.internal instead of localhost.

Screenshot 2022-12-29 at 2 55 39 PM

Above menu is also accessible from Team & Settings > Data Sources. Click on New button to add existing database.

image

You need to specify the project name, API type, and other database parameters.

image

Currently it supports MySQL, Postgres, MSSQL and SQLite.

You can also configure associated SSL & advanced parameters.

image
tip

You can click Edit Connection JSON and modify SSL settings in "ssl".

{
  "client": "pg",
  "connection": {
    "host": "<YOUR_HOST>",
    "port": "5432",
    "user": "<YOUR_DB_USER>",
    "password": "<YOUR_DB_PASSWORD>",
    "database": "<YOUR_DB_NAME>",
    "ssl": {
      "require": true,
      "rejectUnauthorized": false,
      "sslMode": "no-verify"
    }
  }
}
tip

You can click Edit Connection JSON and specify the schema you want to use in "searchPath".

{
  "client": "pg",
  "connection": {
    ...
  },
  "searchPath": [ "<YOUR_TARGET_SCHEMA>" ]
}

Click Test Database Connection to see if the connection can be established or not. NocoDB creates a new empty database with specified parameters if the database doesn't exist.

image
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/display-value/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/display-value/index.html index a08046741e..2060c472ce 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/display-value/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/display-value/index.html @@ -4,13 +4,13 @@ Display Value | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Display Value

What is a Display Value ?​

  • Display Value as the name stands is the primary or main value within a row of a table that you generally associate that row with.
  • It should be usually associated with a column which is uniquely identifiable. However, this uniqueness is not enforced at the database level.
  • Before v0.105.0, Display Value was known as Primary Value.

What is the use of Display Value ?​

  • Within a spreadsheet, Display Value are always highlighted so that it is easier to recognise what row we are in.
  • And when LinkToAnotherRecord is created between two tables - it is the Display Value that appears in LinkToAnotheRecord column.

Example : Display Value highlighted in Actor table​

image

Example : Display Value highlighted in Film table​

image

Example : Display Value associated when LinkToAnotherRecord is created​

image

How to set Display Value ?​

Click down arrow in the target column. Click Set as Display Value.

image

How is Display Value identfied for existing database tables ?​

  • It is usually the first column after the primary key which is not a number.
  • If there is no column which is not a number then the column adjacent to primary key is chosen.

Can I change the Display Value to another column within tables ?​

  • Yes, you can use the same way mentioned above to set Display Value.
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/expanded-form/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/expanded-form/index.html index c01a7c3e07..ccb2f02a1f 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/expanded-form/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/expanded-form/index.html @@ -4,13 +4,13 @@ Expanded Form | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Expanded Form

Overview​

Expanded Form allows you to edit a row data in a form. It also shows the activity feed such as user comments or revision history. It can be also shared by others by copying the record URL.

image

Expanding a Record​

In a grid view, we can hover a row record and a doulbe arrow will be shown. By clicking it, the expanded form will be opened.

image

Alternatively, we can highlight a cell and press the space bar. The expanded form for the correpsonding row will be opened.

Activity Feed​

In an expanded form, we can click Toggle Comment View button to show the activity feed where we can optionally filter out comments only.

image

Copy Record URL​

In an expanded form, we can click Copy Record URL to share the record form to other authorized users.

image

Save Button Option​

By default, when we save the form, the expanded form will be closed, i.e. Save & Exit. However, if we prefer not to close the form even after saving, we can choose Save & Stay mode instead. This is useful when you are editing a long form and you want to save it from time to time.

image

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/formulas/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/formulas/index.html index 9cad5cfd95..a6d83c0425 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/formulas/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/formulas/index.html @@ -4,14 +4,14 @@ Formulas | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Formulas

Adding formula column​

image

1. Click on '+' (Add column)​

2. Populate column Name​

3. Select column Type as 'Formula'​

4. Insert required formula​

  • You can use explicit numerical values/ strings as needed, e.g. 123 (numeric) or "123" (string).
  • You can reference column names in equation with {}, e.g. {column_name}, if the column name conflicts with literals
  • Table below lists supported formula & associated syntax
  • Nested formula (formula equation referring to another formula column) is supported

5. Click on 'Save'​

Editing formula column​

Unlike other column types, formula cells cannot be modified by double-clicking since the value is generated based on the formula. Instead, the vaule can be changed by updating the formula in the column setting.

image

Available Formula Features​

Numeric Functions​

NameSyntaxSampleOutput
ABSABS(value)ABS({Column})Absolute value of the input parameter
ADDADD(value1,[value2,...])ADD({Column1}, {Column2})Sum of input parameters
AVGAVG(value1,[value2,...])AVG({Column1}, {Column2})Average of input parameters
CEILINGCEILING(value)CEILING({Column})Rounded next largest integer value of input parameter
EXPEXP(value)EXP({Column})Exponential value of input parameter (e^x)
FLOORFLOOR(value)FLOOR({Column})Rounded largest integer less than or equal to input parameter
INTINT(value)INT({Column})Integer value of input parameter
LOGLOG([base], value)LOG(10, {Column})Logarithm of input parameter to the base (default = e) specified
MAXMAX(value1,[value2,...])MAX({Column1}, {Column2}, {Column3})Maximum value amongst input parameters
MINMIN(value1,[value2,...])MIN({Column1}, {Column2}, {Column3})Minimum value amongst input parameters
MODMOD(value1, value2)MOD({Column}, 2)Remainder after integer division of input parameters
POWERPOWER(base, exponent)POWER({Column}, 3)base to the exponent power, as in base ^ exponent
ROUNDROUND(value, precision)ROUND({Column}, 3)Round input value to decimal place specified by precision (Nearest integer if precision not provided)
SQRTSQRT(value)SQRT({Column})Square root of the input parameter

Numeric Operators​

OperatorSampleDescription
+{Column1} + {Column2} + 2Addition of numeric values
-{Column1} - {Column2}Subtraction of numeric values
*{Column1} * {Column2}Multiplication of numeric values
/{Column1} / {Column2}Division of numeric values
tip

To change the order of arithmetic operation, you can use round bracket parantheses ().
Example: ({Column1} + ({Column2} * {Column3}) / (3 - $Column4$ ))

String Functions​

NameSyntaxSampleOutput
CONCATCONCAT(str1, [str2,...])CONCAT({Column1}, ' ', {Column2})Concatenated string of input parameters
LEFTLEFT(str1, n)LEFT({Column}, 3)n characters from the beginning of input parameter
LENLEN(str)LEN({Column})Input parameter character length
LOWERLOWER(str)LOWER({Column})Lower case converted string of input parameter
MIDMID(str, position, [count])MID({Column}, 3, 2)Alias for SUBSTR
REPEATREPEAT(str, count)REPEAT({Column}, 2)Specified copies of the input parameter string concatenated together
REPLACEREPLACE(str, srchStr, rplcStr)REPLACE({Column}, 'int', 'num')String, after replacing all occurrences of srchStr with rplcStr
RIGHTRIGHT(str, n)RIGHT({Column}, 3)n characters from the end of input parameter
SEARCHSEARCH(str, srchStr)SEARCH({Column}, 'str')Index of srchStr specified if found, 0 otherwise
SUBSTRSUBTR(str, position, [count])SUBSTR({Column}, 3, 2)Substring of length 'count' of input string, from the postition specified
TRIMTRIM(str)TRIM({Column})Remove trailing and leading whitespaces from input parameter
UPPERUPPER(str)UPPER({Column})Upper case converted string of input parameter
URLURL(str)URL({Column})Convert to a hyperlink if it is a valid URL

Date Functions​

NameSyntaxSampleOutputRemark
NOWNOW()NOW()2022-05-19 17:20:43Returns the current time and day
IF(NOW() < {DATE_COL}, "true", "false")IF(NOW() < date, "true", "false")If current date is less than {DATE_COL}, it returns true. Otherwise, it returns false.DateTime columns and negative values are supported.
DATEADDDATEADD(date \| datetime, value, ["day" \| "week" \| "month" \| "year"])DATEADD(date, 1, 'day')Supposing {DATE_COL} is 2022-03-14. The result is 2022-03-15.DateTime columns and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'day')
DATEADD(date, 1, 'week')Supposing {DATE_COL} is 2022-03-14 03:14. The result is 2022-03-21 03:14.DateTime columns and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'week')
DATEADD(date, 1, 'month')Supposing {DATE_COL} is 2022-03-14 03:14. The result is 2022-04-14 03:14.DateTime columns and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'month')
DATEADD(date, 1, 'year')Supposing {DATE_COL} is 2022-03-14 03:14. The result is 2023-03-14 03:14.DateTime columns and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'year')
IF(NOW() < DATEADD(date,10,'day'), "true", "false")If the current date is less than {DATE_COL} plus 10 days, it returns true. Otherwise, it returns false.DateTime columns and negative values are supported.
IF(NOW() < DATEADD(date,10,'day'), "true", "false")If the current date is less than {DATE_COL} plus 10 days, it returns true. Otherwise, it returns false.DateTime columns and negative values are supported.
DATETIME_DIFFDATETIME_DIFF(date, date, ["milliseconds" \| "ms" \| "seconds" \| "s" \| "minutes" \| "m" \| "hours" \| "h" \| "days" \| "d" \| "weeks" \| "w" \| "months" \| "M" \| "quarters" \| "Q" \| "years" \| "y"])DATETIME_DIFF("2022/10/14", "2022/10/15", "second")Supposing {DATE_COL_1} is 2017-08-25 and {DATE_COL_2} is 2011-08-25. The result is 86400.Compares two dates and returns the difference in the unit specified. Positive integers indicate the second date being in the past compared to the first and vice versa for negative ones.
WEEKDAY(NOW(), "sunday")If today is Monday, it returns 1Get the week day of NOW() with the first day set as sunday
WEEKDAYWEEKDAY(date, [startDayOfWeek])WEEKDAY(NOW())If today is Monday, it returns 0Returns the day of the week as an integer between 0 and 6 inclusive starting from Monday by default. You can optionally change the start day of the week by specifying in the second argument
WEEKDAY(NOW(), "sunday")If today is Monday, it returns 1Get the week day of NOW() with the first day set as sunday

Logical Operators​

OperatorSampleDescription
<{Column1} < {Column2}Less than
>{Column1} > {Column2}Greater than
<={Column1} <= {Column2}Less than or equal to
>={Column1} >= {Column2}Greater than or equal to
=={Column1} == {Column2}Equal to
!={Column1} != {Column2}Not equal to

Conditional Expressions​

NameSyntaxSampleOutput
IFIF(expr, successCase, elseCase)IF({Column} > 1, Value1, Value2)successCase if expr evaluates to TRUE, elseCase otherwise
SWITCHSWITCH(expr, [pattern, value, ..., default])SWITCH({Column}, 1, 'One', 2, 'Two', '--')Switch case value based on expr output
ANDAND(expr1, [expr2,...])AND({Column} > 2, {Column} < 10)TRUE if all expr evaluate to TRUE
OROR(expr1, [expr2,...])OR({Column} > 2, {Column} < 10)TRUE if at least one expr evaluates to TRUE

Logical operators, along with Numerical operators can be used to build conditional expressions.

Examples: 

IF({marksSecured} > 80, "GradeA", "GradeB")  
SWITCH({quarterNumber},  
    1, 'Jan-Mar',
    2, 'Apr-Jun',
    3, 'Jul-Sep',
    4, 'Oct-Dec',
    'INVALID'
)
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/import-airtable-to-sql-database-within-a-minute-for-free/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/import-airtable-to-sql-database-within-a-minute-for-free/index.html index 16ac88177a..59756101ad 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/import-airtable-to-sql-database-within-a-minute-for-free/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/import-airtable-to-sql-database-within-a-minute-for-free/index.html @@ -4,7 +4,7 @@ Import Airtable to NocoDB | NocoDB - + @@ -12,7 +12,7 @@
Skip to main content
Version: 0.109.7 - Old UI

Import Airtable to NocoDB

NocoDB allows a complete import of your Airtable to any MySQL, Postgres, SQLite and SQL server databases within minutes.

note

Import from Airtable is in beta version. See Importing Airtable To NocoDB for the migration notes.

Get Airtable Credentials​

note

You need to retrieve API key and Shared Base ID / URL from Airtable.

Retrieve API Key​

Retrieve Share Base ID / URL​

See here for detailed procedures.

  1. Open Share menu in your Project / Base Screenshot 2022-05-16 at 3 47 27 PM

  2. Open tab Share Publicly

  3. Enable Turn on full base access

  4. Copy generated shared base URL Screenshot 2022-05-16 at 3 41 54 PM

Import Airtable to NocoDB​

note

Prerequisites:
- A NocoDB Project
- Airtable Credentials

Below are 3 simple steps

  1. Go to your Project, Open Add / Import menu and click Airtable.

Screenshot 2022-09-14 at 9 27 51 AM

  1. Input API key & Shared Base ID / URL (retrieved from Get Airtable Credentials above).
  • <1> API Key
  • <2> Share Base ID
  • <3> Configuration option
    • Import Data: disable this option to import only table & view schema's
    • Import Secondary Views: disable this option to import only primary grid view per table
    • Import Rollup Columns: disable this option to skip Rollup column import
    • Import Lookup Columns: disable this option to skip Lookup column import
    • Import Attachments Columns: disable this option to skip Attachment column import
    • \<Not supported yet> Import Formula Columns: disable this option to skip Formula (computation) column import

Screenshot 2022-09-14 at 9 30 14 AM

  1. Click Import and you will see the status
  2. Wait until Go To Dashboard button is activated on the modal. Import details are captured in log window.

Screenshot 2022-09-14 at 9 33 42 AM

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/keyboard-maneuver/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/keyboard-maneuver/index.html index 3f4dd06602..a1d902322a 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/keyboard-maneuver/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/keyboard-maneuver/index.html @@ -4,13 +4,13 @@ Keyboard Maneuver | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Keyboard Maneuver

Shortcuts​

KeyBehaviour
ALT tInsert new table
ALT rInsert new row
ALT cInsert new column
ALT fToggle fullscreen mode
ALT iInvite a member to team
ALT ,Open Team & Settings menu

Grid view​

KeyBehaviour
⌘ ↑Jump to first record in this column (in same page)
⌘ ↓Jump to last record in this column (in same page)
⌘ CCopy cell contents
EnterSwitch cell in focus to EDIT mode; opens modal/picker if cell is associated with one
EscExit cell EDIT mode
DeleteClear cell
SpaceExpand current row
← → ↑ ↓General cell navigation
TabMove to next cell horizontally; if on last cell, move to next row beginning

Column type specific​

DatatypeKeyBehaviour
Text / Numerical cells← →Move cursor to the left / right
↑ ↓Move cursor to the beginning / end
Single Select↑ ↓Move between options
EnterSelect option
Multi Select↑ ↓Move between options
EnterSelect / deselect option
DateTimeCtrl ;Select current date time
Link↑ ↓Move between options
EnterLink current selection
CheckboxEnterToggle
Rating<0 ~ Max>Enter number to toggle rating

Expanded form​

KeyBehaviour
⌘ EnterSave current expanded form item
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/languages/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/languages/index.html index 524b83f968..98c4881b7e 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/languages/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/languages/index.html @@ -4,13 +4,13 @@ Languages | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Languages

NocoDB supports multiple lanuages on dashboard. By default, English will be used. However, if you prefer to display in other languages, you can do the following steps to change the language.

Open Project Menu (click on project name on left top to access Project menu)

image

and select the one you prefer.

If you want to help translate, please check out i18n. If you want to request a new language, please create an issue on Github.

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/link-to-another-record/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/link-to-another-record/index.html index 2c15cd8f56..a8d75374fa 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/link-to-another-record/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/link-to-another-record/index.html @@ -4,7 +4,7 @@ Link To Another Record | NocoDB - + @@ -12,7 +12,7 @@
Skip to main content
Version: 0.109.7 - Old UI

Link To Another Record

Relationship types:​

  • One to one
    • A Table record in first table is related to only one record of second table.
    • Example: Country has a capital city
  • One to many
    • A Table record in first table is related to more than one record of second table. But second table record maps to only one entry of first table
    • NocoDB refers to this category of relationship as has many
    • For every has many relation defined, NocoDB augments belongs to relationship column in the other table automatically
    • Example: Country has many Cities. (other way mapping > City belongs to Country )
  • Many to many
    • A Table record in first table is related to more than one record of second table; second table record can also map to more than on record of first table.
    • NocoDB refers to this category of relationship as many to many
    • For every many to many relation defined between tables, NocoDB augments many to many relationship column in the other table automatically
    • Example: Film has many Actors. Actor has many Films (works on many films)

Further details of relationship types can be found here

Relationships between table records can be established by using LinkToAnotherRecord column type. Workflow details are captured below

Adding a relationship​

image

1. Create column​

Click on '+' button at end of column headers

2. Update column name​

Input name in the text box provided

3. Select column type​

Select Column type as "LinkToAnotherRecord" from the drop-down menu

4. Choose relationship type​

  • 'Has Many' corresponds to the 'One-to-many' relationships
  • 'Many To Many' corresponds to the 'Many-to-many' relationships

5. Select child table from drop down menu​

6. Click on 'Save'​

A new column will get created in both the parent table & child table

Updating linked records​

Click on the '+' icon in corresponding row - cell

image

2. Select from the option displayed​

Use 'Filter box' to narrow down on search items You can opt to insert a new record as well, using "+ New Record" button

image

3. Column mapping showing "Has Many" relationship​

Sheet1 'has many' Sheet2

image

4. Column mapping for "Belongs to" relationship [Automatically updated]​

Sheet2 'belongs to' Sheet1

image
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/links/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/links/index.html index dc73ecb7b4..7580f0f04e 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/links/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/links/index.html @@ -4,7 +4,7 @@ Links | NocoDB - + @@ -21,7 +21,7 @@ A new column will get created in both the parent table & child table

You can opt to insert a new record as well, using "+ New Record" button.
You can use ALT + Click to insert multiple options together.

Screenshot 2023-06-27 at 11 08 40 AM

3. Column display for "Has Many" relationship​

Country 'has many' City

Screenshot 2023-06-27 at 11 11 50 AM

4. Column display for "Belongs to" relationship [Automatically updated]​

City 'belongs to' Country.
Note: Primary value is still used as cell display value for "Belongs to" as it can have only one associated record.

Screenshot 2023-06-27 at 11 12 27 AM

Unlinking records​

  1. Click on link count to open Child modal
  2. Click on Unlink icon against required item

Screenshot 2023-06-27 at 11 22 00 AM

Use column edit menu for Links to reconfigure display label

Screenshot 2023-06-27 at 11 16 19 AM

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/lookup/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/lookup/index.html index 41c0174604..574e393b9e 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/lookup/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/lookup/index.html @@ -4,13 +4,13 @@ Lookup | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Lookup

Lookup​

Example organization structure​

Consider an organization with

  • 5 departments (company departments), each department has a team name & associated team code. Each Team has many Employees - relationship has been defined using LinkToAnotherRecord or Linkscolumn
  • 5 employees working at different departments

Screenshot 2022-09-09 at 12 57 32 PM

Now, let's explore procedure to retrieve team-code information in Employee table using LOOKUP columns

Configuring a lookup column​

1. Add new column : Click on '+' icon to the left of column headers in Employee table​

2. Feed column name​

3. Select column type as 'Lookup'​

4. Choose child table​

5. Select child column​

6. Click on 'Save'​

Screenshot 2022-09-09 at 12 21 13 PM

Required information is now populated in the newly created column

Screenshot 2022-09-09 at 12 26 06 PM

Additional notes​

  • Nested 'Lookup' supported: a Lookup field can have its child column datatype as Lookup (or Rollup).
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/meta-management/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/meta-management/index.html index 311670e1d6..aba4e88101 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/meta-management/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/meta-management/index.html @@ -4,14 +4,14 @@ Data Sources | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Data Sources

Overview​

Data Sources sub-menu includes

  • Database Metadata
  • UI Access Control
  • ERD
  • Add/Remove new data source
  • Edit existing data source configuration
  • Edit data source visibility options

Note that, currently only one external data source can be added per project.

Accessing Data Sources​

To access it, click the down arrow button next to Project Name on the top left side, then select Team & Settings and clicking Data Sources.

image

image

Sync Metadata​

Go to Data Sources, click Sync Metadata, you can see your metadata sync status. If it is out of sync, you can sync the schema. See Sync Schema for more.

image

UI Access Control​

Go to Data Sources, click UI ACL, you can control the access to each table by roles.

image

ERD​

Go to Data Sources, click ERD, you can see the ERD of your database.

image

Junction table names within ERD​

  • Enable Show M2M Tables within Project Settings menu
  • Double click on Show Columns to see additional checkboxes get enabled.
    • Enabling which you should be able to see junction tables and their table names.

image

Edit external database configuration parameters​

Go to Data Sources, click Edit, you can re-configure database credentials.
Please make sure database configuration parameters are valid. Any incorrect parameters could lead to schema loss!

image

Go to Data Sources, click Delete against the data source that you wish to un-link.

image

Data source visibility​

Go to Data Sources, toggle Radio-button against the data source that you wish to hide/un-hide.

image

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/primary-key/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/primary-key/index.html index 41113c9085..d877dfc0ab 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/primary-key/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/primary-key/index.html @@ -4,14 +4,14 @@ Primary Key | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Primary Key

What is a Primary Key ?​

  • A primary key is a special database table column designated to uniquely identify each table record.

What is the use of Primary Key ?​

  • As it uniquely identifies an individual record of a table, it is used internally by NocoDB for all operations associated with a record

Primary Key in NocoDB​

  • Primary Key that gets defined / used in NocoDB depends on how underlying table was created. Summary is captured below
  1. From UI, Create new table / Import from Excel / Import from CSV
    1. An ID [datatype: Integer] system field created by default during table creation is used as primary key
    2. Additional system fields created-at, updated-at are inserted by default & can be omitted optionally; these fields can be deleted after table creation
  2. Connect to existing external database
    1. Existing primary key field defined for a table is retained as is; NocoDB doesn't insert a new ID field
    2. Additional system fields created-at, updated-at are not inserted by default
  3. Import from Airtable
    1. Airtable record ID is marked as primary key for imported records, and is mapped to field ncRecordId [datatype: varchar]
    2. If a new record is inserted after migration & if ncRecordId field was omitted during record insertion - auto generated string will be inserted by NocoDB
    3. Computed hash value for the entire record is stored in system field ncRecordHash
    4. Additional system fields created-at, updated-at are not inserted by default
  4. Create new table using SDK / API
    1. No default primary key field is introduced by NocoDB. It has to be explicitly specified during table creation (using attribute pk: true)

What if Primary Key was missing?​

It is possible to have a table without any primary key.

  • External database table can be created without primary key configuration.
  • New table can be created using SDK / API without primary key In such scenario's, new records can be created in NocoDB for this table, but records can't be updated or deleted [as there is now way for NocoDB to uniquely identify these records]

Example : Primary Key & optional system fields during new table creation​

image

Example : Show System Fields​

image

Can I change the Primary Key to another column within tables ?​

  • You can't update Primary Key from NocoDB UI. You can reconfigure it at database level directly & trigger meta sync explicitly.
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/project-settings/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/project-settings/index.html index 6131d1bdd8..17fc7d2fba 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/project-settings/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/project-settings/index.html @@ -4,13 +4,13 @@ Project settings | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Project settings

Overview​

Generic project configuration options are retained under Project Settings menu. To access it, click the down arrow button next to Project Name on the top left side, then select Team & Settings.

image

Then, under SETTINGS, click Project Settings.

image

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/rollup/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/rollup/index.html index 8ebb4916c3..796192b4e5 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/rollup/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/rollup/index.html @@ -4,13 +4,13 @@ Rollup | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Rollup

Rollup​

Sample Organization structure:

  • 5 Departments, each department has a team name & associated team code
  • 5 employees working at different Departments
  • Teams has many Employees : relationship has been defined

Screenshot 2022-09-09 at 12 57 32 PM

RollUp AGGREGATION functions supported​

  • Count
  • Minimum
  • Maximum
  • Average
  • Sum
  • Count Distinct
  • Sum Distinct
  • Average Distinct

Now, we can explore how to extract employee count information per team using "ROLLUP" columns

Adding a rollup column​

1. Add new column​

Click on '+' icon to the left of column headers in Departments table

2. Feed column name​

3. Select Column type as 'Rollup'​

4. Choose Child Table​

Table Employee in our example

5. Choose on ​Child column​

Pick appropriate column for aggreagation

6. Select ​Aggregate function​

Aggregate function will be "count" in our case

7. Click on Save​

Screenshot 2022-09-09 at 1 03 49 PM

Column Employee Count is populated with appropriate information

image

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/share-base/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/share-base/index.html index a073bcae53..c5962d1d25 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/share-base/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/share-base/index.html @@ -4,13 +4,13 @@ Share Base | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Share Base

Generate Share base​

  • Open Project
  • Click on Invite Team button on bottom left tool bar

image

  • Under Shared base link tab and toggle from Disabled Share base to Anyone with the link

image

  • Share base link generated is displayed over & can be used to share this project to others in the team [Selection (2) in the image below]

Screenshot 2022-02-19 at 12 01 58 PM

Modify Share base​

Modifying Share base will invalidate the Share base link generated previously and will generate a new link.

  • Open Project base
  • Click on 'Share' button on top right tool bar
  • Click on 'Reload' button on Quick menu (next to Shared base link)

Disable Share base​

Disabling Share base will invalidate the generated Share base link

  • Open Project base
  • Click on 'Share' button on top right tool bar
  • Under Shared base link and toggle from Anyone with the link to Disable Share base

Share base Access Permissions​

Shared base can be configured as

  • Viewer - User with the link will get READ ONLY access to the project data.
  • Editor - User with the link will get READ & WRITE access to the project data.

Embeddable Frame​

NocoDB interface can be embedded into existing applications easily by making use of HTML IFRAME) attribute.

Generate embeddable HTML code​

  • Open Project base
  • Click on 'Share' button on top right tool bar
  • Under 'Shared base link' tab
    • Click on button to copy 'Embeddable HTML code'

Example:

<iframe
    class="nc-embed"
    src="https://nocodb-nocodb-rsyir.ondigitalocean.app/dashboard/#/nc/base/e3bba9df-4fc1-4d11-b7ce-41c4a3ad6810?embed"
    frameBorder="0"
    width="100%"
    height="700"
    style="background: transparent; border: 1px solid #ddd"
>
</iframe>

Embed into application's HTML Body​

Sample code with embedded iframe generated above

<!DOCTYPE html>
<html>
    <body>
        <iframe
            class="nc-embed"
            src="http://localhost:3000/#/nc/base/7d4b551c-b5e0-41c9-a87b-f3984c21d2c7?embed"
            frameBorder="0"
            width="100%"
            height="700"
            style="background: transparent; "
        ></iframe>
    </body>
</html>
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/share-view/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/share-view/index.html index cd7598f535..34e423471a 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/share-view/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/share-view/index.html @@ -4,13 +4,13 @@ Share View | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Share View

Generate Share View​

  • Open a table or a view

  • Click Share View on the toolbar

image

  • Copy the link and share to someone

image

  • Optionally you can enable Use Theme to select the share view theme (Only Form View is supported currently)

image

  • or you can enable Restrict access with a password if you want a password-protected view

image

  • or you can Download allowed if you want the people with this link can download the data

image

Access Share View​

  • Access the link. If it is password-protected, enter the password to unlock.

image

  • Otherwise, you should see the share view.

image

- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/sync-schema/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/sync-schema/index.html index 83777e7f48..6944fa8db5 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/sync-schema/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/sync-schema/index.html @@ -4,13 +4,13 @@ Sync Schema | NocoDB - +
Skip to main content
Version: 0.109.7 - Old UI

Sync Schema

How to sync schema changes to NocoDB​

NocoDB allows you to sync schema changes if you have made changes outside NocoDB GUI. However, it has to be noted then you will have to bring your own schema migrations for moving from one environment to other.

Below are the steps to sync schema changes.

1. From the Project menu, click Team & Settings​

image

2. Click Data Source under SETTINGS, click Sync Metadata on the target base​

image

image

3. Changes carried outside GUI, identified by NocoDB are listed under Sync state​

  • If changes made to the database are not visible, click Reload
  • Identified schema changes are identified for each table in red
  • Sync now button gets activated, if Schema changes are identified by NocoDB

image

4. Click Sync Now to complete Schema sync procedure​

Notes​

  1. Column rename operation will be treated like column delete & column create operation.
  2. Only table schema changes identified will be listed under Sync state. Any changes to records are automatically synchronized.
- + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/table-operations/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/table-operations/index.html index 6fef680b4e..168ab2ab24 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/table-operations/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/table-operations/index.html @@ -4,7 +4,7 @@ Table Operations | NocoDB - + @@ -14,7 +14,7 @@ image
  • Click Import to start importing process. The table will be created and the data will be imported. image

    • Import Excel data into an Existing Project​

    note

    If your Excel file contains multiple sheets, each sheet will be stored in a separate table.

    image

    Export Data​

    You can export your data from a table as a CSV file by clicking the down arrow next to Table name and hover on Download. Currently only CSV and XLSX formats are supported for export.

    image

    Import Data​

    You can import your data in CSV format to a table by clicking the down arrow next to Table name and hover on Upload. Currently only CSV format is supported for upload.

    image
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/team-and-auth/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/team-and-auth/index.html index 2de90a28d6..83614aca58 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/team-and-auth/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/team-and-auth/index.html @@ -4,13 +4,13 @@ Team & Auth | NocoDB - +
    Skip to main content
    Version: 0.109.7 - Old UI

    Team & Auth

    Accessing Team & Auth​

    • Click on Team & Settings from the Project Menu
    • Access Team & Auth under Settings
    image

    User Management​

    How to Add a User​

    1. Go to Team & Auth, click on Invite Team

    image

    1. Enter the user's E-mail. Select User Role, and Click Invite.
    tip

    You can add multiple comma (,) seperated emails

    Screenshot 2022-09-13 at 10 54 39 AM

    If you do not have an SMTP sender configured, make sure to copy the invite link and manually send it to your collaborator.

    Screenshot 2022-09-13 at 10 54 22 AM

    How to Update user permissions​

    1. Use Edit <1> menu to assign a different role to existing user
    2. Use Delete <2> menu to remove a user from accessing current project

    image

    User Role Permissions​

    Advanced Options & Configurations​

                                                           Owner        Creator        Editor    Commenter    Viewer    
    Audit✅✅❌❌❌
    App Store✅❌❌❌❌
    Team & Auth✅❌❌❌❌
    Project Metadata✅❌❌❌❌
    New user: Add Owner✅❌❌❌❌
    New user: Add Creator✅❌❌❌❌
    New user: Add Editor✅✅❌❌❌
    New user: Add Commenter✅✅❌❌❌
    New user: Add Viewer✅✅❌❌❌
    View existing users✅✅❌❌❌
    Preview mode✅✅❌❌❌

    Schema Options​

                                                           Owner        Creator        Editor    Commenter    Viewer    
    Add table✅✅❌❌❌
    Delete table✅✅❌❌❌
    Modify table✅✅❌❌❌
    Add column✅✅❌❌❌
    Delete column✅✅❌❌❌
    Modify column✅✅❌❌❌

    Record Options​

                                                           Owner        Creator        Editor    Commenter    Viewer    
    Add row✅✅✅❌❌
    Delete row✅✅✅❌❌
    Modify row/ cell✅✅✅❌❌
    Expand row✅✅✅❌❌
    Right click on cell (add/edit row)✅✅✅❌❌
    View table data (cell) contents✅✅✅✅✅

    Comments​

                                                           Owner        Creator        Editor    Commenter    Viewer    
    View comments from others✅✅✅✅❌
    Add comments✅✅✅✅❌

    Views​

                                                           Owner        Creator        Editor    Commenter    Viewer    
    Create new view✅✅❌❌❌
    Share view✅✅❌❌❌

    Project Generals​

                                                           Owner        Creator        Editor    Commenter    Viewer    
    Created views access✅✅✅✅✅
    Filter fields/ Column✅✅✅✅✅
    Filter fields/ Query✅✅✅✅✅
    Sort fields✅✅✅✅✅
    Theme✅✅✅✅✅
    Auth token✅✅✅✅✅
    Project Info✅✅✅✅✅
    Swagger API✅✅✅✅✅

    API Tokens Management​

    NocoDB allows creating API tokens which allow it to be integrated seamlessly with 3rd party apps. API Token is a Nano ID with a length of 40. If you are passing API Token, make sure that the header is called xc-token.

    • Open Project Menu, click on Team & Settings
    image

    • Click API Tokens Management tab under Team & Auth section

    • Click Add New Token

    image

    • Type an recognizable name for your token and click Generate

    Screenshot 2022-09-14 at 10 20 10 AM

    • Copy API token to your clipboard; use action menu to the right of token list
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/usage-information/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/usage-information/index.html index 3cda2de0f9..dccc16588b 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/usage-information/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/usage-information/index.html @@ -4,7 +4,7 @@ Usage Information | NocoDB - + @@ -15,7 +15,7 @@ To that end, NocoDB contains a feature in which anonymous and otherwise non-sens This anonymous and non-sensitive data gives a better understanding of how users are interacting and using the product.

    Context​

    We will always continue to do hands-on UI/UX testing, surveys, issue tracking and roadmap. Otherwise talk with the Community while striving to understand and deliver what is being asked for and what is needed, by any means available.

    However, these above actions alone are often insufficient

    What we collect ?​

    We collect actions made on models (project, table, view, sharedView, user, hook, image, sharedBase etc) periodically with :

    Our UI Dashboard is a Vuejs-Nuxtjs app. Actions taken on UI with completely anonymized route names are sent as payload.

    What we DO NOT collect ?​

    We do not collect any private or sensitive information, such as:

    Opt-out​

    To disable usage information collection please set following environment variable.

    NC_DISABLE_TELE=true

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/0.109.7/setup-and-usages/views/index.html b/packages/noco-docs/dist/0.109.7/setup-and-usages/views/index.html index a9111da7bf..7faba06716 100644 --- a/packages/noco-docs/dist/0.109.7/setup-and-usages/views/index.html +++ b/packages/noco-docs/dist/0.109.7/setup-and-usages/views/index.html @@ -4,13 +4,13 @@ Views | NocoDB - +
    Skip to main content
    Version: 0.109.7 - Old UI

    Views

    What's a View?​

    In a table, you can use different views to display your data. You can show specific fields in a View. You can also apply Sorting or Filtering to the View. Each View is independent, which means the configuration applying to View 1 will not apply to View 2.

    To navigate different views, we can select the target one in the view sidebar. By default, Grid View will be created for you after creating the table. You can create multiple views of a type, as long as they have unique View names.

    View Menu Bar​

    To work with Views, use View menu-bar on the right hand side -

    • <1> Toggle View menu-bar.
    • <2> Displays created view-list for the selected table
      • Currently active view is high-lighted
    • <3> Add new view to the list

    image

    View Types​

    Grid View​

    Grid View, as a default type of view, allows you to display your data in a spreadsheet-like interface.

    1010-2 Grid

    Form View​

    Form View allows you to arrange fields in a form to input data.

    1010-2 Form

    You can drag-drop columns from the form to form-field-menu-bar as requried.

    Gallery View allows you to display images as thumbnails with other fields just like a gallery.

    1010-2 Gallery

    Kanban View​

    Kanban View allows you to visualise your data using cards at various stacks.

    1010-2 Kanban

    View Permission Types​

    We can apply permission to each View. By default, Collaborative Views will be used. To see or change the view type, expand view-tool-bar-menu as shown below.

    Screenshot 2022-09-09 at 3 46 33 PM

    Collaborative Views (default)​

    • Collaborators with edit permissions or higher can change the view configurations

    Locked Views​

    • No one can edit view configurations until it is Unlocked
    • All collaborators can only READ data from such views

    Personal Views​

    • Only you can edit the view configuration.
    • Your personal views are hidden for other collaborators
    • Are not available currently; will be enabled in future release

    View Operations​

    Screenshot 2022-09-09 at 3 27 46 PM

    Create a View​

    Click '+' in View-menu sidebar, as shown in <3>.

    Rename a View​

    Double click on view-name, edit, .

    Delete a View​

    Hover the target View and click the delete icon, as shown in <2>.

    note

    You cannot delete the very first Grid View (termed as Default view).

    Duplicate a View​

    Hover the target View and click the copy icon, as shown in <2>.

    Reorder a View​

    Hover the target View and re-order it as needed by drag-drop the drag icon, as shown in <1>.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/404.html b/packages/noco-docs/dist/404.html index 523bb95a44..cd488e2266 100644 --- a/packages/noco-docs/dist/404.html +++ b/packages/noco-docs/dist/404.html @@ -4,13 +4,13 @@ Page Not Found | NocoDB - +
    Skip to main content

    Page Not Found

    We could not find what you were looking for.

    Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/FAQs/index.html b/packages/noco-docs/dist/FAQs/index.html index 8d12d4de76..d1dede8e29 100644 --- a/packages/noco-docs/dist/FAQs/index.html +++ b/packages/noco-docs/dist/FAQs/index.html @@ -4,15 +4,15 @@ FAQs | NocoDB - +
    -
    Skip to main content
    Version: Latest

    FAQs

    How to upgrade NocoDB ?​

    How to export CSV from the grid view ?​

    How to share the project with read only access ?​

    • Either you can invite by email with 'viewer' access control
    • Share the base with publicly accessible link. Available since 0.82.0

    How to check my Project info ?​

    • You can open Project context menu and click Copy Project Info.

    image

    You should see the similar result as below.

    Node: **v18.16.4**
    Arch: **arm64**
    Platform: **linux**
    Docker: **true**
    RootDB: **sqlite3**
    PackageVersion: **0.111.0**

    What is available in free version ?​

    • Detailed comparison of NocoDB's generous CE compared to others is here.
    • NocoDB has just one version that is free & open source.
    • In it you will notice advanced features are all available for free.
      • ACL
      • Collaboration
      • Advanced Views : Form View, Gallery View & Kanban View
      • Share View
      • Embed View
      • Password protected View
      • Automations
      • API Token Support
    • And we would never move these features from free to an enterprise version of NocoDB.
    • There is no limitations to number of projects, records or fields either.

    What is the difference between Auth Token and API Token ?​

    Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN. If you are passing Auth Token, make sure that the header is called xc-auth.

    API Token is a Nano ID with a length of 40. If you are passing API Token, make sure that the header is called xc-token.

    Do we plan to have an Enterprise Edition?​

    For features that make sense for enterprises like below - yes

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/account-settings/api-tokens/index.html b/packages/noco-docs/dist/account-settings/api-tokens/index.html index f5b755bfd9..f1c96df740 100644 --- a/packages/noco-docs/dist/account-settings/api-tokens/index.html +++ b/packages/noco-docs/dist/account-settings/api-tokens/index.html @@ -4,13 +4,13 @@ API tokens | NocoDB - +
    -
    Version: Latest

    API tokens

    Create API Token​

    Open Account Settings page from the user menu in the bottom left corner of the sidebar.

    1. Click on User menu in the bottom left corner of the sidebar,
    2. Select Account Settings from the dropdown

    profile page

    Follow the steps below to create API Token

    1. Click on Tokens tab in the Account Settings page
    2. Click on Add New API Token
    3. Enter the name for the API Token
    4. Click on Save button to save the changes

    Create API Token

    Create API Token

    danger

    Only one token can be created per user

    API Token created will get added to the list. Copy API token by clicking on Copy button displayed under Actions menu

    Create API Token

    Delete API Token​

    Open Account Settings page from the user menu in the bottom left corner of the sidebar.

    1. Click on User menu in the bottom left corner of the sidebar,
    2. Select Account Settings from the dropdown

    profile page

    1. Click on Tokens tab in the Account Settings page
    2. From the Actions menu, click on Delete button associated with the API Token to be deleted

    Delete API Token

    danger

    Note that, all the services using the API Token will stop working once the API Token is deleted.

    - +
    Version: Latest

    API tokens

    Create API Token​

    Open Account Settings page from the user menu in the bottom left corner of the sidebar.

    1. Click on User menu in the bottom left corner of the sidebar,
    2. Select Account Settings from the dropdown

    profile page

    Follow the steps below to create API Token

    1. Click on Tokens tab in the Account Settings page
    2. Click on Add New API Token
    3. Enter the name for the API Token
    4. Click on Save button to save the changes

    Create API Token

    Create API Token

    danger

    Only one token can be created per user

    API Token created will get added to the list. Copy API token by clicking on Copy button displayed under Actions menu

    Create API Token

    Delete API Token​

    Open Account Settings page from the user menu in the bottom left corner of the sidebar.

    1. Click on User menu in the bottom left corner of the sidebar,
    2. Select Account Settings from the dropdown

    profile page

    1. Click on Tokens tab in the Account Settings page
    2. From the Actions menu, click on Delete button associated with the API Token to be deleted

    Delete API Token

    danger

    Note that, all the services using the API Token will stop working once the API Token is deleted.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/account-settings/oss-specific-details/index.html b/packages/noco-docs/dist/account-settings/oss-specific-details/index.html index e417cf977b..e800b2a587 100644 --- a/packages/noco-docs/dist/account-settings/oss-specific-details/index.html +++ b/packages/noco-docs/dist/account-settings/oss-specific-details/index.html @@ -4,14 +4,14 @@ In Open Source | NocoDB - +
    -
    Version: Latest

    In Open Source

    Some of the Account settings features are available only in Open Source NocoDB. This article explains details about such specifics.

    Enable / Disable Signup​

    Signup without an invitation is disabled by default and can be managed from UI by a super admin.

    Invite only signup

    App Store​

    App store lists available integrations for NocoDB. You can install and configure these integrations from the App store.

    Screenshot 2023-08-22 at 5 02 26 PM +

    Version: Latest

    In Open Source

    Some of the Account settings features are available only in Open Source NocoDB. This article explains details about such specifics.

    Enable / Disable Signup​

    Signup without an invitation is disabled by default and can be managed from UI by a super admin.

    Invite only signup

    App Store​

    App store lists available integrations for NocoDB. You can install and configure these integrations from the App store.

    Screenshot 2023-08-22 at 5 02 26 PM We provide different integrations in three main categories.

    CategoryApp Name
    ChatMicrosoft Teams
    Discord
    Twilio
    Whatsapp Twilio
    Mattermost
    Slack
    EmailSMTP
    MailerSend
    AWS SES
    StorageAWS S3
    Minio
    Google Cloud Storage
    Spaces
    Backblaze B2
    Vultr Object Storage
    OvhCloud Object Storage
    Linode Object Storage
    UpCloud Object Storage
    Scaleway Object Storage
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/account-settings/profile-page/index.html b/packages/noco-docs/dist/account-settings/profile-page/index.html index bd4d6ceef5..bb962a7219 100644 --- a/packages/noco-docs/dist/account-settings/profile-page/index.html +++ b/packages/noco-docs/dist/account-settings/profile-page/index.html @@ -4,13 +4,13 @@ Profile page | NocoDB - +
    -
    Version: Latest

    Profile page

    Profile page is the place where you can manage your profile information. Currently, only a custom username can be setup as part of profile configuration. To access your profile page,

    1. Click on User menu in the bottom left corner of the sidebar,
    2. Select Account Settings from the dropdown
    3. Change Profile name
    4. Click on Save button to save the changes

    profile page

    profile page

    - +
    Version: Latest

    Profile page

    Profile page is the place where you can manage your profile information. Currently, only a custom username can be setup as part of profile configuration. To access your profile page,

    1. Click on User menu in the bottom left corner of the sidebar,
    2. Select Account Settings from the dropdown
    3. Change Profile name
    4. Click on Save button to save the changes

    profile page

    profile page

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/assets/js/935f2afb.56686250.js b/packages/noco-docs/dist/assets/js/935f2afb.db7a4e77.js similarity index 97% rename from packages/noco-docs/dist/assets/js/935f2afb.56686250.js rename to packages/noco-docs/dist/assets/js/935f2afb.db7a4e77.js index e7a42ead41..07ea08018c 100644 --- a/packages/noco-docs/dist/assets/js/935f2afb.56686250.js +++ b/packages/noco-docs/dist/assets/js/935f2afb.db7a4e77.js @@ -1 +1 @@ -"use strict";(self.webpackChunknoco_docs=self.webpackChunknoco_docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Latest","banner":null,"badge":true,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Welcome","href":"/","docId":"index"},{"type":"category","label":"Getting Started","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Quick start","href":"/getting-started/quick-start","docId":"getting-started/quick-start"},{"type":"link","label":"NocoDB terminologies","href":"/getting-started/terminologies","docId":"getting-started/terminologies"},{"type":"link","label":"Keyboard shortcuts","href":"/getting-started/keyboard-shortcuts","docId":"getting-started/keyboard-shortcuts"},{"type":"category","label":"In Open Source","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Installation","href":"/getting-started/self-hosted/installation","docId":"getting-started/self-hosted/installation"},{"type":"link","label":"Environment variables","href":"/getting-started/self-hosted/environment-variables","docId":"getting-started/self-hosted/environment-variables"},{"type":"link","label":"Upgrading","href":"/getting-started/self-hosted/upgrading","docId":"getting-started/self-hosted/upgrading"}]}]},{"type":"category","label":"Workspaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Workspace overview","href":"/workspaces/workspace-overview","docId":"workspaces/workspace-overview"},{"type":"link","label":"Create workspace","href":"/workspaces/create-workspace","docId":"workspaces/create-workspace"},{"type":"link","label":"Workspace collaboration","href":"/workspaces/workspace-collaboration","docId":"workspaces/workspace-collaboration"},{"type":"link","label":"Actions on workspace","href":"/workspaces/actions-on-workspace","docId":"workspaces/actions-on-workspace"}]},{"type":"category","label":"Bases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Base overview","href":"/bases/base-overview","docId":"bases/base-overview"},{"type":"link","label":"Create base","href":"/bases/create-base","docId":"bases/create-base"},{"type":"link","label":"Import Airtable to NocoDB","href":"/bases/import-base-from-airtable","docId":"bases/import-base-from-airtable"},{"type":"link","label":"Base collaboration","href":"/bases/base-collaboration","docId":"bases/base-collaboration"},{"type":"link","label":"Share base","href":"/bases/share-base","docId":"bases/share-base"},{"type":"link","label":"Actions on base","href":"/bases/actions-on-base","docId":"bases/actions-on-base"}]},{"type":"category","label":"Tables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Table overview","href":"/tables/table-overview","docId":"tables/table-overview"},{"type":"link","label":"Create empty table","href":"/tables/create-table","docId":"tables/create-table"},{"type":"link","label":"Create table via import","href":"/tables/create-table-via-import","docId":"tables/create-table-via-import"},{"type":"link","label":"Import data into an existing table","href":"/tables/import-data-into-existing-table","docId":"tables/import-data-into-existing-table"},{"type":"link","label":"Actions on table","href":"/tables/actions-on-table","docId":"tables/actions-on-table"}]},{"type":"category","label":"Table operations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Table operations overview","href":"/table-operations/overview","docId":"table-operations/overview"},{"type":"link","label":"Hide & reorder fields","href":"/table-operations/field-operations","docId":"table-operations/field-operations"},{"type":"link","label":"Filtering records","href":"/table-operations/filter","docId":"table-operations/filter"},{"type":"link","label":"Sorting records","href":"/table-operations/sort","docId":"table-operations/sort"},{"type":"link","label":"Grouping records","href":"/table-operations/group-by","docId":"table-operations/group-by"},{"type":"link","label":"Record height","href":"/table-operations/row-height","docId":"table-operations/row-height"},{"type":"link","label":"Search","href":"/table-operations/search","docId":"table-operations/search"},{"type":"link","label":"Download","href":"/table-operations/download","docId":"table-operations/download"}]},{"type":"category","label":"Table Details","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Table details overview","href":"/table-details/table-details-overview","docId":"table-details/table-details-overview"}]},{"type":"category","label":"Fields","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Fields overview","href":"/fields/fields-overview","docId":"fields/fields-overview"},{"type":"link","label":"Primary key","href":"/fields/primary-key","docId":"fields/primary-key"},{"type":"link","label":"Display value","href":"/fields/display-value","docId":"fields/display-value"},{"type":"category","label":"Field types","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Text based","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Single line text","href":"/fields/field-types/text-based/single-line-text","docId":"fields/field-types/text-based/single-line-text"},{"type":"link","label":"Long text","href":"/fields/field-types/text-based/long-text","docId":"fields/field-types/text-based/long-text"},{"type":"link","label":"Email","href":"/fields/field-types/text-based/email","docId":"fields/field-types/text-based/email"},{"type":"link","label":"Phone Number","href":"/fields/field-types/text-based/phonenumber","docId":"fields/field-types/text-based/phonenumber"},{"type":"link","label":"URL","href":"/fields/field-types/text-based/url","docId":"fields/field-types/text-based/url"}]},{"type":"category","label":"Numerical","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Number","href":"/fields/field-types/numerical/number","docId":"fields/field-types/numerical/number"},{"type":"link","label":"Decimal","href":"/fields/field-types/numerical/decimal","docId":"fields/field-types/numerical/decimal"},{"type":"link","label":"Percent","href":"/fields/field-types/numerical/percent","docId":"fields/field-types/numerical/percent"},{"type":"link","label":"Currency","href":"/fields/field-types/numerical/currency","docId":"fields/field-types/numerical/currency"}]},{"type":"category","label":"Select based","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Single Select","href":"/fields/field-types/select-based/single-select","docId":"fields/field-types/select-based/single-select"},{"type":"link","label":"Checkbox","href":"/fields/field-types/select-based/checkbox","docId":"fields/field-types/select-based/checkbox"},{"type":"link","label":"Multi Select","href":"/fields/field-types/select-based/multi-select","docId":"fields/field-types/select-based/multi-select"},{"type":"link","label":"Rating","href":"/fields/field-types/select-based/rating","docId":"fields/field-types/select-based/rating"}]},{"type":"category","label":"Links based","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Links","href":"/fields/field-types/links-based/links","docId":"fields/field-types/links-based/links"},{"type":"link","label":"Lookup","href":"/fields/field-types/links-based/lookup","docId":"fields/field-types/links-based/lookup"},{"type":"link","label":"Rollup","href":"/fields/field-types/links-based/rollup","docId":"fields/field-types/links-based/rollup"}]},{"type":"category","label":"Custom types","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Attachment","href":"/fields/field-types/custom-types/attachment","docId":"fields/field-types/custom-types/attachment"},{"type":"link","label":"QR code","href":"/fields/field-types/custom-types/QR-code","docId":"fields/field-types/custom-types/QR-code"},{"type":"link","label":"Barcode","href":"/fields/field-types/custom-types/barcode","docId":"fields/field-types/custom-types/barcode"},{"type":"link","label":"Geometry","href":"/fields/field-types/custom-types/geometry","docId":"fields/field-types/custom-types/geometry"},{"type":"link","label":"Specific DB type","href":"/fields/field-types/custom-types/specific-db-type","docId":"fields/field-types/custom-types/specific-db-type"},{"type":"link","label":"JSON","href":"/fields/field-types/custom-types/json","docId":"fields/field-types/custom-types/json"}]},{"type":"category","label":"Formula","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Formula","href":"/fields/field-types/formula/formula","docId":"fields/field-types/formula/formula"},{"type":"link","label":"Numeric and Logical Operators","href":"/fields/field-types/formula/operators","docId":"fields/field-types/formula/operators"},{"type":"link","label":"Numeric functions","href":"/fields/field-types/formula/numeric-functions","docId":"fields/field-types/formula/numeric-functions"},{"type":"link","label":"String functions","href":"/fields/field-types/formula/string-functions","docId":"fields/field-types/formula/string-functions"},{"type":"link","label":"Date functions","href":"/fields/field-types/formula/date-functions","docId":"fields/field-types/formula/date-functions"},{"type":"link","label":"Conditional expressions","href":"/fields/field-types/formula/conditional-expressions","docId":"fields/field-types/formula/conditional-expressions"}]},{"type":"category","label":"Date Time based","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Date Time","href":"/fields/field-types/date-time-based/date-time","docId":"fields/field-types/date-time-based/date-time"},{"type":"link","label":"Date","href":"/fields/field-types/date-time-based/date","docId":"fields/field-types/date-time-based/date"},{"type":"link","label":"Time","href":"/fields/field-types/date-time-based/time","docId":"fields/field-types/date-time-based/time"},{"type":"link","label":"Duration","href":"/fields/field-types/date-time-based/duration","docId":"fields/field-types/date-time-based/duration"}]}]},{"type":"link","label":"Multi-field editor","href":"/fields/multi-fields-editor","docId":"fields/multi-fields-editor"},{"type":"link","label":"Actions on field","href":"/fields/actions-on-field","docId":"fields/actions-on-field"}]},{"type":"category","label":"Records","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Records overview","href":"/records/records-overview","docId":"records/records-overview"},{"type":"link","label":"Create record","href":"/records/create-record","docId":"records/create-record"},{"type":"link","label":"Expanded record","href":"/records/expand-record","docId":"records/expand-record"},{"type":"link","label":"Actions on record","href":"/records/actions-on-record","docId":"records/actions-on-record"}]},{"type":"category","label":"Views","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"View overview","href":"/views/views-overview","docId":"views/views-overview"},{"type":"link","label":"Create view","href":"/views/create-view","docId":"views/create-view"},{"type":"link","label":"Share view","href":"/views/share-view","docId":"views/share-view"},{"type":"category","label":"View types","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Grid","href":"/views/view-types/grid","docId":"views/view-types/grid"},{"type":"link","label":"Gallery","href":"/views/view-types/gallery","docId":"views/view-types/gallery"},{"type":"link","label":"Form","href":"/views/view-types/form","docId":"views/view-types/form"},{"type":"link","label":"Kanban","href":"/views/view-types/kanban","docId":"views/view-types/kanban"}]},{"type":"link","label":"Actions on view","href":"/views/actions-on-view","docId":"views/actions-on-view"}]},{"type":"category","label":"Data sources","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Data sources overview","href":"/data-sources/data-source-overview","docId":"data-sources/data-source-overview"},{"type":"link","label":"Connect to a Data source","href":"/data-sources/connect-to-data-source","docId":"data-sources/connect-to-data-source"},{"type":"link","label":"Sync with Data source","href":"/data-sources/sync-with-data-source","docId":"data-sources/sync-with-data-source"},{"type":"link","label":"Actions on Data sources","href":"/data-sources/actions-on-data-sources","docId":"data-sources/actions-on-data-sources"}]},{"type":"category","label":"Roles and permissions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Roles & permissions overview","href":"/roles-and-permissions/roles-permissions-overview","docId":"roles-and-permissions/roles-permissions-overview"}]},{"type":"category","label":"Collaboration","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Collaboration overview","href":"/collaboration/collaboration-overview","docId":"collaboration/collaboration-overview"},{"type":"link","label":"Workspace collaboration","href":"/collaboration/workspace-collaboration","docId":"collaboration/workspace-collaboration"},{"type":"link","label":"Base collaboration","href":"/collaboration/base-collaboration","docId":"collaboration/base-collaboration"},{"type":"link","label":"Share base","href":"/collaboration/share-base","docId":"collaboration/share-base"},{"type":"link","label":"Share view","href":"/collaboration/share-view","docId":"collaboration/share-view"},{"type":"link","label":"In Open Source","href":"/collaboration/oss-specific-details","docId":"collaboration/oss-specific-details"}]},{"type":"category","label":"Automation","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Webhook","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Webhook overview","href":"/automation/webhook/webhook-overview","docId":"automation/webhook/webhook-overview"},{"type":"link","label":"Create webhook","href":"/automation/webhook/create-webhook","docId":"automation/webhook/create-webhook"},{"type":"link","label":"Actions on webhook","href":"/automation/webhook/actions-on-webhook","docId":"automation/webhook/actions-on-webhook"}]}]},{"type":"category","label":"Account settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Profile page","href":"/account-settings/profile-page","docId":"account-settings/profile-page"},{"type":"link","label":"API tokens","href":"/account-settings/api-tokens","docId":"account-settings/api-tokens"},{"type":"link","label":"In Open Source","href":"/account-settings/oss-specific-details","docId":"account-settings/oss-specific-details"}]},{"type":"category","label":"Engineering","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Architecture overview","href":"/engineering/architecture","docId":"engineering/architecture"},{"type":"link","label":"Repository structure","href":"/engineering/repository-structure","docId":"engineering/repository-structure"},{"type":"link","label":"Development setup","href":"/engineering/development-setup","docId":"engineering/development-setup"},{"type":"link","label":"Writing unit tests","href":"/engineering/unit-testing","docId":"engineering/unit-testing"},{"type":"link","label":"Playwright E2E testing","href":"/engineering/playwright","docId":"engineering/playwright"},{"type":"link","label":"Releases & builds","href":"/engineering/builds-and-releases","docId":"engineering/builds-and-releases"},{"type":"link","label":"i18n translation","href":"/engineering/translation","docId":"engineering/translation"},{"type":"link","label":"Writing docs","href":"/engineering/writing-docs","docId":"engineering/writing-docs"}]},{"type":"link","label":"FAQs","href":"/FAQs","docId":"FAQs"}]},"docs":{"account-settings/api-tokens":{"id":"account-settings/api-tokens","title":"API tokens","description":"This article explains how to create and work with API Tokens.","sidebar":"tutorialSidebar"},"account-settings/oss-specific-details":{"id":"account-settings/oss-specific-details","title":"In Open Source","description":"This article explains Account settings specifics in Open source NocoDB.","sidebar":"tutorialSidebar"},"account-settings/profile-page":{"id":"account-settings/profile-page","title":"Profile page","description":"This article explains how to manage your profile page.","sidebar":"tutorialSidebar"},"automation/webhook/actions-on-webhook":{"id":"automation/webhook/actions-on-webhook","title":"Actions on webhook","description":"Learn how to enable/disable, duplicate and delete webhooks.","sidebar":"tutorialSidebar"},"automation/webhook/create-webhook":{"id":"automation/webhook/create-webhook","title":"Create webhook","description":"Learn how to create a webhook in NocoDB.","sidebar":"tutorialSidebar"},"automation/webhook/webhook-overview":{"id":"automation/webhook/webhook-overview","title":"Webhook overview","description":"Learn how to create, modify and delete webhooks.","sidebar":"tutorialSidebar"},"bases/actions-on-base":{"id":"bases/actions-on-base","title":"Actions on base","description":"Actions you can perform on a base in NocoDB: Rename, duplicate, delete, star a base.","sidebar":"tutorialSidebar"},"bases/base-collaboration":{"id":"bases/base-collaboration","title":"Base collaboration","description":"Invite team members to work on a base","sidebar":"tutorialSidebar"},"bases/base-overview":{"id":"bases/base-overview","title":"Base overview","description":"This article explains the concept of bases in NocoDB.","sidebar":"tutorialSidebar"},"bases/create-base":{"id":"bases/create-base","title":"Create base","description":"Learn how to create a base in NocoDB.","sidebar":"tutorialSidebar"},"bases/import-base-from-airtable":{"id":"bases/import-base-from-airtable","title":"Import Airtable to NocoDB","description":"A complete import of your Airtable to any MySQL or Postgres databases within minutes","sidebar":"tutorialSidebar"},"bases/share-base":{"id":"bases/share-base","title":"Share base","description":"Procedures to share a base & generating embedded iframe","sidebar":"tutorialSidebar"},"collaboration/base-collaboration":{"id":"collaboration/base-collaboration","title":"Base collaboration","description":"Invite team members to work on a base","sidebar":"tutorialSidebar"},"collaboration/collaboration-overview":{"id":"collaboration/collaboration-overview","title":"Collaboration overview","description":"This article explains various collaboration features that NocoDB offers.","sidebar":"tutorialSidebar"},"collaboration/oss-specific-details":{"id":"collaboration/oss-specific-details","title":"In Open Source","description":"This article explains specifics of User management in OSS.","sidebar":"tutorialSidebar"},"collaboration/share-base":{"id":"collaboration/share-base","title":"Share base","description":"Procedures to share a base publicly & generating embedded iframe","sidebar":"tutorialSidebar"},"collaboration/share-view":{"id":"collaboration/share-view","title":"Share view","description":"Procedures to share a view publicly","sidebar":"tutorialSidebar"},"collaboration/workspace-collaboration":{"id":"collaboration/workspace-collaboration","title":"Workspace collaboration","description":"This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.","sidebar":"tutorialSidebar"},"data-sources/actions-on-data-sources":{"id":"data-sources/actions-on-data-sources","title":"Actions on Data sources","description":"Learn more about actions that can be performed on data sources in NocoDB.","sidebar":"tutorialSidebar"},"data-sources/connect-to-data-source":{"id":"data-sources/connect-to-data-source","title":"Connect to a Data source","description":"Learn how to connect to an external data-source (PG/MySQL) in NocoDB.","sidebar":"tutorialSidebar"},"data-sources/data-source-overview":{"id":"data-sources/data-source-overview","title":"Data sources overview","description":"NocoDB Data-Source sync, access control & re-config","sidebar":"tutorialSidebar"},"data-sources/sync-with-data-source":{"id":"data-sources/sync-with-data-source","title":"Sync with Data source","description":"Learn how to sync changes done in external data source with NocoDB.","sidebar":"tutorialSidebar"},"engineering/architecture":{"id":"engineering/architecture","title":"Architecture overview","description":"Simple overview of NocoDB architecture","sidebar":"tutorialSidebar"},"engineering/builds-and-releases":{"id":"engineering/builds-and-releases","title":"Releases & builds","description":"NocoDB creates Docker and Binaries for each PR","sidebar":"tutorialSidebar"},"engineering/development-setup":{"id":"engineering/development-setup","title":"Development setup","description":"How to set-up your development environment","sidebar":"tutorialSidebar"},"engineering/playwright":{"id":"engineering/playwright","title":"Playwright E2E testing","description":"Overview to playwright based e2e tests","sidebar":"tutorialSidebar"},"engineering/repository-structure":{"id":"engineering/repository-structure","title":"Repository structure","description":"Repository Structure","sidebar":"tutorialSidebar"},"engineering/translation":{"id":"engineering/translation","title":"i18n translation","description":"Contribute to NocoDB\'s i18n translation","sidebar":"tutorialSidebar"},"engineering/unit-testing":{"id":"engineering/unit-testing","title":"Writing unit tests","description":"Overview to Unit Testing","sidebar":"tutorialSidebar"},"engineering/writing-docs":{"id":"engineering/writing-docs","title":"Writing docs","description":"Overview to writing docs","sidebar":"tutorialSidebar"},"FAQs":{"id":"FAQs","title":"FAQs","description":"General FAQs","sidebar":"tutorialSidebar"},"fields/actions-on-field":{"id":"fields/actions-on-field","title":"Actions on field","description":"This article explains how to perform various actions on a field- like rename, change field type, default, field width, record height, show/hide.","sidebar":"tutorialSidebar"},"fields/display-value":{"id":"fields/display-value","title":"Display value","description":"This article explains how to set display value for a table & its use.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/attachment":{"id":"fields/field-types/custom-types/attachment","title":"Attachment","description":"This article explains how to create & work with an Attachment field.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/barcode":{"id":"fields/field-types/custom-types/barcode","title":"Barcode","description":"This article explains how to create & work with a Barcode field.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/geometry":{"id":"fields/field-types/custom-types/geometry","title":"Geometry","description":"This article explains how to create & work with a Geometry field.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/json":{"id":"fields/field-types/custom-types/json","title":"JSON","description":"JSON is a custom field type that allows you to store JSON data in a field. Useful for storing data that can be represented as a JSON object, like API Response, or a set of key-value pairs.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/QR-code":{"id":"fields/field-types/custom-types/QR-code","title":"QR code","description":"This article explains how to create & work with a QR code field.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/specific-db-type":{"id":"fields/field-types/custom-types/specific-db-type","title":"Specific DB type","description":"This article explains how to create & work with a Specific DB Type field.","sidebar":"tutorialSidebar"},"fields/field-types/date-time-based/date":{"id":"fields/field-types/date-time-based/date","title":"Date","description":"This article explains how to create & work with a Date field.","sidebar":"tutorialSidebar"},"fields/field-types/date-time-based/date-time":{"id":"fields/field-types/date-time-based/date-time","title":"Date Time","description":"This article explains how to create & work with a Date Time field.","sidebar":"tutorialSidebar"},"fields/field-types/date-time-based/duration":{"id":"fields/field-types/date-time-based/duration","title":"Duration","description":"This article explains how to create & work with a Duration field.","sidebar":"tutorialSidebar"},"fields/field-types/date-time-based/time":{"id":"fields/field-types/date-time-based/time","title":"Time","description":"This article explains how to create & work with a Time field.","sidebar":"tutorialSidebar"},"fields/field-types/formula/conditional-expressions":{"id":"fields/field-types/formula/conditional-expressions","title":"Conditional expressions","description":"This article explains various conditional expressions that can be used in formula fields.","sidebar":"tutorialSidebar"},"fields/field-types/formula/date-functions":{"id":"fields/field-types/formula/date-functions","title":"Date functions","description":"This article explains various date functions that can be used in formula fields.","sidebar":"tutorialSidebar"},"fields/field-types/formula/formula":{"id":"fields/field-types/formula/formula","title":"Formula","description":"This article explains how to create & work with a Formula field.","sidebar":"tutorialSidebar"},"fields/field-types/formula/numeric-functions":{"id":"fields/field-types/formula/numeric-functions","title":"Numeric functions","description":"This article explains various numeric functions that can be used in formula fields.","sidebar":"tutorialSidebar"},"fields/field-types/formula/operators":{"id":"fields/field-types/formula/operators","title":"Numeric and Logical Operators","description":"This article explains various numeric and logical operators that can be used in formula fields.","sidebar":"tutorialSidebar"},"fields/field-types/formula/string-functions":{"id":"fields/field-types/formula/string-functions","title":"String functions","description":"This article explains various string functions that can be used in formula fields.","sidebar":"tutorialSidebar"},"fields/field-types/links-based/links":{"id":"fields/field-types/links-based/links","title":"Links","description":"This article explains how to create & work with a Links field.","sidebar":"tutorialSidebar"},"fields/field-types/links-based/lookup":{"id":"fields/field-types/links-based/lookup","title":"Lookup","description":"This article explains how to create & work with a Lookup field.","sidebar":"tutorialSidebar"},"fields/field-types/links-based/rollup":{"id":"fields/field-types/links-based/rollup","title":"Rollup","description":"This article explains how to create & work with a Rollup field.","sidebar":"tutorialSidebar"},"fields/field-types/numerical/currency":{"id":"fields/field-types/numerical/currency","title":"Currency","description":"This article explains how to create & work with a Currency field.","sidebar":"tutorialSidebar"},"fields/field-types/numerical/decimal":{"id":"fields/field-types/numerical/decimal","title":"Decimal","description":"This article explains how to create & work with a Decimal field.","sidebar":"tutorialSidebar"},"fields/field-types/numerical/number":{"id":"fields/field-types/numerical/number","title":"Number","description":"This article explains how to create & work with a Number field.","sidebar":"tutorialSidebar"},"fields/field-types/numerical/percent":{"id":"fields/field-types/numerical/percent","title":"Percent","description":"This article explains how to create & work with a Percent field.","sidebar":"tutorialSidebar"},"fields/field-types/select-based/checkbox":{"id":"fields/field-types/select-based/checkbox","title":"Checkbox","description":"This article explains how to create & work with a Checkbox field.","sidebar":"tutorialSidebar"},"fields/field-types/select-based/multi-select":{"id":"fields/field-types/select-based/multi-select","title":"Multi Select","description":"This article explains how to create & work with a Multi select field.","sidebar":"tutorialSidebar"},"fields/field-types/select-based/rating":{"id":"fields/field-types/select-based/rating","title":"Rating","description":"This article explains how to create & work with a Rating field.","sidebar":"tutorialSidebar"},"fields/field-types/select-based/single-select":{"id":"fields/field-types/select-based/single-select","title":"Single Select","description":"This article explains how to create & work with a Single select field.","sidebar":"tutorialSidebar"},"fields/field-types/text-based/email":{"id":"fields/field-types/text-based/email","title":"Email","description":"This article explains how to create & work with an Email field.","sidebar":"tutorialSidebar"},"fields/field-types/text-based/long-text":{"id":"fields/field-types/text-based/long-text","title":"Long text","description":"This article explains how to create & work with a Long text field.","sidebar":"tutorialSidebar"},"fields/field-types/text-based/phonenumber":{"id":"fields/field-types/text-based/phonenumber","title":"Phone Number","description":"This article explains how to create & work with a Phone number field.","sidebar":"tutorialSidebar"},"fields/field-types/text-based/single-line-text":{"id":"fields/field-types/text-based/single-line-text","title":"Single line text","description":"This article explains how to create & work with a Single line text field.","sidebar":"tutorialSidebar"},"fields/field-types/text-based/url":{"id":"fields/field-types/text-based/url","title":"URL","description":"This article explains how to create & work with an URL field.","sidebar":"tutorialSidebar"},"fields/fields-overview":{"id":"fields/fields-overview","title":"Fields overview","description":"This article discusses various field types that NocoDB offers.","sidebar":"tutorialSidebar"},"fields/multi-fields-editor":{"id":"fields/multi-fields-editor","title":"Multi-field editor","description":"Understanding use of multi-field editor in NocoDB!","sidebar":"tutorialSidebar"},"fields/primary-key":{"id":"fields/primary-key","title":"Primary key","description":"This article explains what a primary key is and how it is used in NocoDB.","sidebar":"tutorialSidebar"},"getting-started/keyboard-shortcuts":{"id":"getting-started/keyboard-shortcuts","title":"Keyboard shortcuts","description":"Quick Actions","sidebar":"tutorialSidebar"},"getting-started/quick-start":{"id":"getting-started/quick-start","title":"Quick start","description":"NocoDB offers you the flexibility of two distinct variants: self-hosted and SaaS (cloud-hosted). In this section, we\'ll walk you through the initial steps to embark on your NocoDB journey, whether you choose to set it up on your own infrastructure or opt for the convenience of our cloud-hosted service. Let\'s dive in and unlock the potential of NocoDB for your data management needs.","sidebar":"tutorialSidebar"},"getting-started/self-hosted/environment-variables":{"id":"getting-started/self-hosted/environment-variables","title":"Environment variables","description":"Environment Variables for NocoDB!","sidebar":"tutorialSidebar"},"getting-started/self-hosted/installation":{"id":"getting-started/self-hosted/installation","title":"Installation","description":"Simple installation - takes about three minutes!","sidebar":"tutorialSidebar"},"getting-started/self-hosted/upgrading":{"id":"getting-started/self-hosted/upgrading","title":"Upgrading","description":"Upgrading NocoDB : Docker, Node and Homebrew!","sidebar":"tutorialSidebar"},"getting-started/terminologies":{"id":"getting-started/terminologies","title":"NocoDB terminologies","description":"To maximize your use of NocoDB, it\'s beneficial to become familiar with some common terms.","sidebar":"tutorialSidebar"},"index":{"id":"index","title":"Welcome","description":"NocoDB Documentation","sidebar":"tutorialSidebar"},"records/actions-on-record":{"id":"records/actions-on-record","title":"Actions on record","description":"Learn how to perform actions (edit, duplicate, delete, etc) on a record in NocoDB.","sidebar":"tutorialSidebar"},"records/create-record":{"id":"records/create-record","title":"Create record","description":"Learn how to create a record in NocoDB.","sidebar":"tutorialSidebar"},"records/expand-record":{"id":"records/expand-record","title":"Expanded record","description":"Learn how to expand a record & work with it in NocoDB.","sidebar":"tutorialSidebar"},"records/records-overview":{"id":"records/records-overview","title":"Records overview","description":"Learn how to create, import, and manage records in NocoDB.","sidebar":"tutorialSidebar"},"roles-and-permissions/roles-permissions-overview":{"id":"roles-and-permissions/roles-permissions-overview","title":"Roles & permissions overview","description":"Learn about roles and permissions in NocoDB.","sidebar":"tutorialSidebar"},"table-details/table-details-overview":{"id":"table-details/table-details-overview","title":"Table details overview","description":"Table details overview","sidebar":"tutorialSidebar"},"table-operations/download":{"id":"table-operations/download","title":"Download","description":"NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.","sidebar":"tutorialSidebar"},"table-operations/field-operations":{"id":"table-operations/field-operations","title":"Hide & reorder fields","description":"Learn how to hide and reorder fields in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/filter":{"id":"table-operations/filter","title":"Filtering records","description":"Learn how to filter records in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/group-by":{"id":"table-operations/group-by","title":"Grouping records","description":"Learn how to group records in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/overview":{"id":"table-operations/overview","title":"Table operations overview","description":"Learn how to work with filters, sort, group by, and more in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/row-height":{"id":"table-operations/row-height","title":"Record height","description":"Learn how to adjust the height of records in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/search":{"id":"table-operations/search","title":"Search","description":"Learn how to search for records in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/sort":{"id":"table-operations/sort","title":"Sorting records","description":"Learn how to sort records in NocoDB.","sidebar":"tutorialSidebar"},"tables/actions-on-table":{"id":"tables/actions-on-table","title":"Actions on table","description":"Learn how to rename, duplicate, and delete a table in NocoDB.","sidebar":"tutorialSidebar"},"tables/create-table":{"id":"tables/create-table","title":"Create empty table","description":"Learn how to create a table in NocoDB.","sidebar":"tutorialSidebar"},"tables/create-table-via-import":{"id":"tables/create-table-via-import","title":"Create table via import","description":"Learn how to create a table in NocoDB via import from CSV, Excel or JSON.","sidebar":"tutorialSidebar"},"tables/import-data-into-existing-table":{"id":"tables/import-data-into-existing-table","title":"Import data into an existing table","description":"Learn how to import data into an existing table in NocoDB.","sidebar":"tutorialSidebar"},"tables/table-overview":{"id":"tables/table-overview","title":"Table overview","description":"Learn how to create, import, and manage tables in NocoDB.","sidebar":"tutorialSidebar"},"views/actions-on-view":{"id":"views/actions-on-view","title":"Actions on view","description":"Learn how to delete, rename, duplicate a a view in NocoDB.","sidebar":"tutorialSidebar"},"views/create-view":{"id":"views/create-view","title":"Create view","description":"Learn how to create a new view in NocoDB.","sidebar":"tutorialSidebar"},"views/share-view":{"id":"views/share-view","title":"Share view","description":"Learn how to share a view publicly in NocoDB.","sidebar":"tutorialSidebar"},"views/view-types/form":{"id":"views/view-types/form","title":"Form","description":"Learn how to create, import, and manage forms in NocoDB.","sidebar":"tutorialSidebar"},"views/view-types/gallery":{"id":"views/view-types/gallery","title":"Gallery","description":"Learn how to work with gallery view in NocoDB.","sidebar":"tutorialSidebar"},"views/view-types/grid":{"id":"views/view-types/grid","title":"Grid","description":"Learn how to work with grid view in NocoDB.","sidebar":"tutorialSidebar"},"views/view-types/kanban":{"id":"views/view-types/kanban","title":"Kanban","description":"Learn how to work with kanban view in NocoDB.","sidebar":"tutorialSidebar"},"views/views-overview":{"id":"views/views-overview","title":"View overview","description":"Understanding Views in NocoDB!","sidebar":"tutorialSidebar"},"workspaces/actions-on-workspace":{"id":"workspaces/actions-on-workspace","title":"Actions on workspace","description":"This article explains how to rename or delete a workspace.","sidebar":"tutorialSidebar"},"workspaces/create-workspace":{"id":"workspaces/create-workspace","title":"Create workspace","description":"Learn how to create a workspace in NocoDB","sidebar":"tutorialSidebar"},"workspaces/workspace-collaboration":{"id":"workspaces/workspace-collaboration","title":"Workspace collaboration","description":"This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.","sidebar":"tutorialSidebar"},"workspaces/workspace-overview":{"id":"workspaces/workspace-overview","title":"Workspace overview","description":"This article briefs the concept of workspaces in NocoDB.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunknoco_docs=self.webpackChunknoco_docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Latest","banner":null,"badge":true,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Welcome","href":"/","docId":"index"},{"type":"category","label":"Getting Started","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Quick start","href":"/getting-started/quick-start","docId":"getting-started/quick-start"},{"type":"link","label":"NocoDB terminologies","href":"/getting-started/terminologies","docId":"getting-started/terminologies"},{"type":"link","label":"Keyboard shortcuts","href":"/getting-started/keyboard-shortcuts","docId":"getting-started/keyboard-shortcuts"},{"type":"category","label":"In Open Source","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Installation","href":"/getting-started/self-hosted/installation","docId":"getting-started/self-hosted/installation"},{"type":"link","label":"Environment variables","href":"/getting-started/self-hosted/environment-variables","docId":"getting-started/self-hosted/environment-variables"},{"type":"link","label":"Upgrading","href":"/getting-started/self-hosted/upgrading","docId":"getting-started/self-hosted/upgrading"}]}]},{"type":"category","label":"Workspaces","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Workspace overview","href":"/workspaces/workspace-overview","docId":"workspaces/workspace-overview"},{"type":"link","label":"Create workspace","href":"/workspaces/create-workspace","docId":"workspaces/create-workspace"},{"type":"link","label":"Workspace collaboration","href":"/workspaces/workspace-collaboration","docId":"workspaces/workspace-collaboration"},{"type":"link","label":"Actions on workspace","href":"/workspaces/actions-on-workspace","docId":"workspaces/actions-on-workspace"}]},{"type":"category","label":"Bases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Base overview","href":"/bases/base-overview","docId":"bases/base-overview"},{"type":"link","label":"Create base","href":"/bases/create-base","docId":"bases/create-base"},{"type":"link","label":"Import Airtable to NocoDB","href":"/bases/import-base-from-airtable","docId":"bases/import-base-from-airtable"},{"type":"link","label":"Base collaboration","href":"/bases/base-collaboration","docId":"bases/base-collaboration"},{"type":"link","label":"Share base","href":"/bases/share-base","docId":"bases/share-base"},{"type":"link","label":"Actions on base","href":"/bases/actions-on-base","docId":"bases/actions-on-base"}]},{"type":"category","label":"Tables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Table overview","href":"/tables/table-overview","docId":"tables/table-overview"},{"type":"link","label":"Create empty table","href":"/tables/create-table","docId":"tables/create-table"},{"type":"link","label":"Create table via import","href":"/tables/create-table-via-import","docId":"tables/create-table-via-import"},{"type":"link","label":"Import data into an existing table","href":"/tables/import-data-into-existing-table","docId":"tables/import-data-into-existing-table"},{"type":"link","label":"Actions on table","href":"/tables/actions-on-table","docId":"tables/actions-on-table"}]},{"type":"category","label":"Table operations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Table operations overview","href":"/table-operations/overview","docId":"table-operations/overview"},{"type":"link","label":"Hide & reorder fields","href":"/table-operations/field-operations","docId":"table-operations/field-operations"},{"type":"link","label":"Filtering records","href":"/table-operations/filter","docId":"table-operations/filter"},{"type":"link","label":"Sorting records","href":"/table-operations/sort","docId":"table-operations/sort"},{"type":"link","label":"Grouping records","href":"/table-operations/group-by","docId":"table-operations/group-by"},{"type":"link","label":"Record height","href":"/table-operations/row-height","docId":"table-operations/row-height"},{"type":"link","label":"Search","href":"/table-operations/search","docId":"table-operations/search"},{"type":"link","label":"Download","href":"/table-operations/download","docId":"table-operations/download"}]},{"type":"category","label":"Table Details","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Table details overview","href":"/table-details/table-details-overview","docId":"table-details/table-details-overview"}]},{"type":"category","label":"Fields","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Fields overview","href":"/fields/fields-overview","docId":"fields/fields-overview"},{"type":"link","label":"Primary key","href":"/fields/primary-key","docId":"fields/primary-key"},{"type":"link","label":"Display value","href":"/fields/display-value","docId":"fields/display-value"},{"type":"category","label":"Field types","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Text based","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Single line text","href":"/fields/field-types/text-based/single-line-text","docId":"fields/field-types/text-based/single-line-text"},{"type":"link","label":"Long text","href":"/fields/field-types/text-based/long-text","docId":"fields/field-types/text-based/long-text"},{"type":"link","label":"Email","href":"/fields/field-types/text-based/email","docId":"fields/field-types/text-based/email"},{"type":"link","label":"Phone Number","href":"/fields/field-types/text-based/phonenumber","docId":"fields/field-types/text-based/phonenumber"},{"type":"link","label":"URL","href":"/fields/field-types/text-based/url","docId":"fields/field-types/text-based/url"}]},{"type":"category","label":"Numerical","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Number","href":"/fields/field-types/numerical/number","docId":"fields/field-types/numerical/number"},{"type":"link","label":"Decimal","href":"/fields/field-types/numerical/decimal","docId":"fields/field-types/numerical/decimal"},{"type":"link","label":"Percent","href":"/fields/field-types/numerical/percent","docId":"fields/field-types/numerical/percent"},{"type":"link","label":"Currency","href":"/fields/field-types/numerical/currency","docId":"fields/field-types/numerical/currency"}]},{"type":"category","label":"Select based","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Single Select","href":"/fields/field-types/select-based/single-select","docId":"fields/field-types/select-based/single-select"},{"type":"link","label":"Checkbox","href":"/fields/field-types/select-based/checkbox","docId":"fields/field-types/select-based/checkbox"},{"type":"link","label":"Multi Select","href":"/fields/field-types/select-based/multi-select","docId":"fields/field-types/select-based/multi-select"},{"type":"link","label":"Rating","href":"/fields/field-types/select-based/rating","docId":"fields/field-types/select-based/rating"}]},{"type":"category","label":"Links based","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Links","href":"/fields/field-types/links-based/links","docId":"fields/field-types/links-based/links"},{"type":"link","label":"Lookup","href":"/fields/field-types/links-based/lookup","docId":"fields/field-types/links-based/lookup"},{"type":"link","label":"Rollup","href":"/fields/field-types/links-based/rollup","docId":"fields/field-types/links-based/rollup"}]},{"type":"category","label":"Custom types","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Attachment","href":"/fields/field-types/custom-types/attachment","docId":"fields/field-types/custom-types/attachment"},{"type":"link","label":"QR code","href":"/fields/field-types/custom-types/QR-code","docId":"fields/field-types/custom-types/QR-code"},{"type":"link","label":"Barcode","href":"/fields/field-types/custom-types/barcode","docId":"fields/field-types/custom-types/barcode"},{"type":"link","label":"Geometry","href":"/fields/field-types/custom-types/geometry","docId":"fields/field-types/custom-types/geometry"},{"type":"link","label":"Specific DB type","href":"/fields/field-types/custom-types/specific-db-type","docId":"fields/field-types/custom-types/specific-db-type"},{"type":"link","label":"JSON","href":"/fields/field-types/custom-types/json","docId":"fields/field-types/custom-types/json"}]},{"type":"category","label":"Formula","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Formula","href":"/fields/field-types/formula/formula","docId":"fields/field-types/formula/formula"},{"type":"link","label":"Numeric and Logical Operators","href":"/fields/field-types/formula/operators","docId":"fields/field-types/formula/operators"},{"type":"link","label":"Numeric functions","href":"/fields/field-types/formula/numeric-functions","docId":"fields/field-types/formula/numeric-functions"},{"type":"link","label":"String functions","href":"/fields/field-types/formula/string-functions","docId":"fields/field-types/formula/string-functions"},{"type":"link","label":"Date functions","href":"/fields/field-types/formula/date-functions","docId":"fields/field-types/formula/date-functions"},{"type":"link","label":"Conditional expressions","href":"/fields/field-types/formula/conditional-expressions","docId":"fields/field-types/formula/conditional-expressions"}]},{"type":"category","label":"Date Time based","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Date Time","href":"/fields/field-types/date-time-based/date-time","docId":"fields/field-types/date-time-based/date-time"},{"type":"link","label":"Date","href":"/fields/field-types/date-time-based/date","docId":"fields/field-types/date-time-based/date"},{"type":"link","label":"Time","href":"/fields/field-types/date-time-based/time","docId":"fields/field-types/date-time-based/time"},{"type":"link","label":"Duration","href":"/fields/field-types/date-time-based/duration","docId":"fields/field-types/date-time-based/duration"}]}]},{"type":"link","label":"Multi-field editor","href":"/fields/multi-fields-editor","docId":"fields/multi-fields-editor"},{"type":"link","label":"Actions on field","href":"/fields/actions-on-field","docId":"fields/actions-on-field"}]},{"type":"category","label":"Records","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Records overview","href":"/records/records-overview","docId":"records/records-overview"},{"type":"link","label":"Create record","href":"/records/create-record","docId":"records/create-record"},{"type":"link","label":"Expanded record","href":"/records/expand-record","docId":"records/expand-record"},{"type":"link","label":"Actions on record","href":"/records/actions-on-record","docId":"records/actions-on-record"}]},{"type":"category","label":"Views","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"View overview","href":"/views/views-overview","docId":"views/views-overview"},{"type":"link","label":"Create view","href":"/views/create-view","docId":"views/create-view"},{"type":"link","label":"Share view","href":"/views/share-view","docId":"views/share-view"},{"type":"category","label":"View types","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Grid","href":"/views/view-types/grid","docId":"views/view-types/grid"},{"type":"link","label":"Gallery","href":"/views/view-types/gallery","docId":"views/view-types/gallery"},{"type":"link","label":"Form","href":"/views/view-types/form","docId":"views/view-types/form"},{"type":"link","label":"Kanban","href":"/views/view-types/kanban","docId":"views/view-types/kanban"}]},{"type":"link","label":"Actions on view","href":"/views/actions-on-view","docId":"views/actions-on-view"}]},{"type":"category","label":"Data sources","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Data sources overview","href":"/data-sources/data-source-overview","docId":"data-sources/data-source-overview"},{"type":"link","label":"Connect to a Data source","href":"/data-sources/connect-to-data-source","docId":"data-sources/connect-to-data-source"},{"type":"link","label":"Sync with Data source","href":"/data-sources/sync-with-data-source","docId":"data-sources/sync-with-data-source"},{"type":"link","label":"Actions on Data sources","href":"/data-sources/actions-on-data-sources","docId":"data-sources/actions-on-data-sources"}]},{"type":"category","label":"Roles and permissions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Roles & permissions overview","href":"/roles-and-permissions/roles-permissions-overview","docId":"roles-and-permissions/roles-permissions-overview"}]},{"type":"category","label":"Collaboration","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Collaboration overview","href":"/collaboration/collaboration-overview","docId":"collaboration/collaboration-overview"},{"type":"link","label":"Workspace collaboration","href":"/collaboration/workspace-collaboration","docId":"collaboration/workspace-collaboration"},{"type":"link","label":"Base collaboration","href":"/collaboration/base-collaboration","docId":"collaboration/base-collaboration"},{"type":"link","label":"Share base","href":"/collaboration/share-base","docId":"collaboration/share-base"},{"type":"link","label":"Share view","href":"/collaboration/share-view","docId":"collaboration/share-view"},{"type":"link","label":"In Open Source","href":"/collaboration/oss-specific-details","docId":"collaboration/oss-specific-details"}]},{"type":"category","label":"Automation","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Webhook","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Webhook overview","href":"/automation/webhook/webhook-overview","docId":"automation/webhook/webhook-overview"},{"type":"link","label":"Create webhook","href":"/automation/webhook/create-webhook","docId":"automation/webhook/create-webhook"},{"type":"link","label":"Actions on webhook","href":"/automation/webhook/actions-on-webhook","docId":"automation/webhook/actions-on-webhook"}]}]},{"type":"category","label":"Account settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Profile page","href":"/account-settings/profile-page","docId":"account-settings/profile-page"},{"type":"link","label":"API tokens","href":"/account-settings/api-tokens","docId":"account-settings/api-tokens"},{"type":"link","label":"In Open Source","href":"/account-settings/oss-specific-details","docId":"account-settings/oss-specific-details"}]},{"type":"category","label":"Engineering","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Architecture overview","href":"/engineering/architecture","docId":"engineering/architecture"},{"type":"link","label":"Repository structure","href":"/engineering/repository-structure","docId":"engineering/repository-structure"},{"type":"link","label":"Development setup","href":"/engineering/development-setup","docId":"engineering/development-setup"},{"type":"link","label":"Writing unit tests","href":"/engineering/unit-testing","docId":"engineering/unit-testing"},{"type":"link","label":"Playwright E2E testing","href":"/engineering/playwright","docId":"engineering/playwright"},{"type":"link","label":"Releases & builds","href":"/engineering/builds-and-releases","docId":"engineering/builds-and-releases"},{"type":"link","label":"i18n translation","href":"/engineering/translation","docId":"engineering/translation"},{"type":"link","label":"Writing docs","href":"/engineering/writing-docs","docId":"engineering/writing-docs"}]},{"type":"link","label":"FAQs","href":"/FAQs","docId":"FAQs"}]},"docs":{"account-settings/api-tokens":{"id":"account-settings/api-tokens","title":"API tokens","description":"This article explains how to create and work with API Tokens.","sidebar":"tutorialSidebar"},"account-settings/oss-specific-details":{"id":"account-settings/oss-specific-details","title":"In Open Source","description":"This article explains Account settings specifics in Open source NocoDB.","sidebar":"tutorialSidebar"},"account-settings/profile-page":{"id":"account-settings/profile-page","title":"Profile page","description":"This article explains how to manage your profile page.","sidebar":"tutorialSidebar"},"automation/webhook/actions-on-webhook":{"id":"automation/webhook/actions-on-webhook","title":"Actions on webhook","description":"Learn how to enable/disable, duplicate and delete webhooks.","sidebar":"tutorialSidebar"},"automation/webhook/create-webhook":{"id":"automation/webhook/create-webhook","title":"Create webhook","description":"Learn how to create a webhook in NocoDB.","sidebar":"tutorialSidebar"},"automation/webhook/webhook-overview":{"id":"automation/webhook/webhook-overview","title":"Webhook overview","description":"Learn how to create, modify and delete webhooks.","sidebar":"tutorialSidebar"},"bases/actions-on-base":{"id":"bases/actions-on-base","title":"Actions on base","description":"Actions you can perform on a base in NocoDB: Rename, duplicate, delete, star a base.","sidebar":"tutorialSidebar"},"bases/base-collaboration":{"id":"bases/base-collaboration","title":"Base collaboration","description":"Invite team members to work on a base","sidebar":"tutorialSidebar"},"bases/base-overview":{"id":"bases/base-overview","title":"Base overview","description":"This article explains the concept of bases in NocoDB.","sidebar":"tutorialSidebar"},"bases/create-base":{"id":"bases/create-base","title":"Create base","description":"Learn how to create a base in NocoDB.","sidebar":"tutorialSidebar"},"bases/import-base-from-airtable":{"id":"bases/import-base-from-airtable","title":"Import Airtable to NocoDB","description":"A complete import of your Airtable to any MySQL or Postgres databases within minutes","sidebar":"tutorialSidebar"},"bases/share-base":{"id":"bases/share-base","title":"Share base","description":"Procedures to share a base & generating embedded iframe","sidebar":"tutorialSidebar"},"collaboration/base-collaboration":{"id":"collaboration/base-collaboration","title":"Base collaboration","description":"Invite team members to work on a base","sidebar":"tutorialSidebar"},"collaboration/collaboration-overview":{"id":"collaboration/collaboration-overview","title":"Collaboration overview","description":"This article explains various collaboration features that NocoDB offers.","sidebar":"tutorialSidebar"},"collaboration/oss-specific-details":{"id":"collaboration/oss-specific-details","title":"In Open Source","description":"This article explains specifics of User management in OSS.","sidebar":"tutorialSidebar"},"collaboration/share-base":{"id":"collaboration/share-base","title":"Share base","description":"Procedures to share a base publicly & generating embedded iframe","sidebar":"tutorialSidebar"},"collaboration/share-view":{"id":"collaboration/share-view","title":"Share view","description":"Procedures to share a view publicly","sidebar":"tutorialSidebar"},"collaboration/workspace-collaboration":{"id":"collaboration/workspace-collaboration","title":"Workspace collaboration","description":"This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.","sidebar":"tutorialSidebar"},"data-sources/actions-on-data-sources":{"id":"data-sources/actions-on-data-sources","title":"Actions on Data sources","description":"Learn more about actions that can be performed on data sources in NocoDB.","sidebar":"tutorialSidebar"},"data-sources/connect-to-data-source":{"id":"data-sources/connect-to-data-source","title":"Connect to a Data source","description":"Learn how to connect to an external data-source (PG/MySQL) in NocoDB.","sidebar":"tutorialSidebar"},"data-sources/data-source-overview":{"id":"data-sources/data-source-overview","title":"Data sources overview","description":"NocoDB Data-Source sync, access control & re-config","sidebar":"tutorialSidebar"},"data-sources/sync-with-data-source":{"id":"data-sources/sync-with-data-source","title":"Sync with Data source","description":"Learn how to sync changes done in external data source with NocoDB.","sidebar":"tutorialSidebar"},"engineering/architecture":{"id":"engineering/architecture","title":"Architecture overview","description":"Simple overview of NocoDB architecture","sidebar":"tutorialSidebar"},"engineering/builds-and-releases":{"id":"engineering/builds-and-releases","title":"Releases & builds","description":"NocoDB creates Docker and Binaries for each PR","sidebar":"tutorialSidebar"},"engineering/development-setup":{"id":"engineering/development-setup","title":"Development setup","description":"How to set-up your development environment","sidebar":"tutorialSidebar"},"engineering/playwright":{"id":"engineering/playwright","title":"Playwright E2E testing","description":"Overview to playwright based e2e tests","sidebar":"tutorialSidebar"},"engineering/repository-structure":{"id":"engineering/repository-structure","title":"Repository structure","description":"Repository Structure","sidebar":"tutorialSidebar"},"engineering/translation":{"id":"engineering/translation","title":"i18n translation","description":"Contribute to NocoDB\'s i18n translation","sidebar":"tutorialSidebar"},"engineering/unit-testing":{"id":"engineering/unit-testing","title":"Writing unit tests","description":"Overview to Unit Testing","sidebar":"tutorialSidebar"},"engineering/writing-docs":{"id":"engineering/writing-docs","title":"Writing docs","description":"Overview to writing docs","sidebar":"tutorialSidebar"},"FAQs":{"id":"FAQs","title":"FAQs","description":"General FAQs","sidebar":"tutorialSidebar"},"fields/actions-on-field":{"id":"fields/actions-on-field","title":"Actions on field","description":"This article explains how to perform various actions on a field- like rename, change field type, default, field width, record height, show/hide.","sidebar":"tutorialSidebar"},"fields/display-value":{"id":"fields/display-value","title":"Display value","description":"This article explains how to set display value for a table & its use.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/attachment":{"id":"fields/field-types/custom-types/attachment","title":"Attachment","description":"This article explains how to create & work with an Attachment field.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/barcode":{"id":"fields/field-types/custom-types/barcode","title":"Barcode","description":"This article explains how to create & work with a Barcode field.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/geometry":{"id":"fields/field-types/custom-types/geometry","title":"Geometry","description":"This article explains how to create & work with a Geometry field.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/json":{"id":"fields/field-types/custom-types/json","title":"JSON","description":"JSON is a custom field type that allows you to store JSON data in a field. Useful for storing data that can be represented as a JSON object, like API Response, or a set of key-value pairs.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/QR-code":{"id":"fields/field-types/custom-types/QR-code","title":"QR code","description":"This article explains how to create & work with a QR code field.","sidebar":"tutorialSidebar"},"fields/field-types/custom-types/specific-db-type":{"id":"fields/field-types/custom-types/specific-db-type","title":"Specific DB type","description":"This article explains how to create & work with a Specific DB Type field.","sidebar":"tutorialSidebar"},"fields/field-types/date-time-based/date":{"id":"fields/field-types/date-time-based/date","title":"Date","description":"This article explains how to create & work with a Date field.","sidebar":"tutorialSidebar"},"fields/field-types/date-time-based/date-time":{"id":"fields/field-types/date-time-based/date-time","title":"Date Time","description":"This article explains how to create & work with a Date Time field.","sidebar":"tutorialSidebar"},"fields/field-types/date-time-based/duration":{"id":"fields/field-types/date-time-based/duration","title":"Duration","description":"This article explains how to create & work with a Duration field.","sidebar":"tutorialSidebar"},"fields/field-types/date-time-based/time":{"id":"fields/field-types/date-time-based/time","title":"Time","description":"This article explains how to create & work with a Time field.","sidebar":"tutorialSidebar"},"fields/field-types/formula/conditional-expressions":{"id":"fields/field-types/formula/conditional-expressions","title":"Conditional expressions","description":"This article explains various conditional expressions that can be used in formula fields.","sidebar":"tutorialSidebar"},"fields/field-types/formula/date-functions":{"id":"fields/field-types/formula/date-functions","title":"Date functions","description":"This article explains various date functions that can be used in formula fields.","sidebar":"tutorialSidebar"},"fields/field-types/formula/formula":{"id":"fields/field-types/formula/formula","title":"Formula","description":"This article explains how to create & work with a Formula field.","sidebar":"tutorialSidebar"},"fields/field-types/formula/numeric-functions":{"id":"fields/field-types/formula/numeric-functions","title":"Numeric functions","description":"This article explains various numeric functions that can be used in formula fields.","sidebar":"tutorialSidebar"},"fields/field-types/formula/operators":{"id":"fields/field-types/formula/operators","title":"Numeric and Logical Operators","description":"This article explains various numeric and logical operators that can be used in formula fields.","sidebar":"tutorialSidebar"},"fields/field-types/formula/string-functions":{"id":"fields/field-types/formula/string-functions","title":"String functions","description":"This article explains various string functions that can be used in formula fields.","sidebar":"tutorialSidebar"},"fields/field-types/links-based/links":{"id":"fields/field-types/links-based/links","title":"Links","description":"This article explains how to create & work with a Links field.","sidebar":"tutorialSidebar"},"fields/field-types/links-based/lookup":{"id":"fields/field-types/links-based/lookup","title":"Lookup","description":"This article explains how to create & work with a Lookup field.","sidebar":"tutorialSidebar"},"fields/field-types/links-based/rollup":{"id":"fields/field-types/links-based/rollup","title":"Rollup","description":"This article explains how to create & work with a Rollup field.","sidebar":"tutorialSidebar"},"fields/field-types/numerical/currency":{"id":"fields/field-types/numerical/currency","title":"Currency","description":"This article explains how to create & work with a Currency field.","sidebar":"tutorialSidebar"},"fields/field-types/numerical/decimal":{"id":"fields/field-types/numerical/decimal","title":"Decimal","description":"This article explains how to create & work with a Decimal field.","sidebar":"tutorialSidebar"},"fields/field-types/numerical/number":{"id":"fields/field-types/numerical/number","title":"Number","description":"This article explains how to create & work with a Number field.","sidebar":"tutorialSidebar"},"fields/field-types/numerical/percent":{"id":"fields/field-types/numerical/percent","title":"Percent","description":"This article explains how to create & work with a Percent field.","sidebar":"tutorialSidebar"},"fields/field-types/select-based/checkbox":{"id":"fields/field-types/select-based/checkbox","title":"Checkbox","description":"This article explains how to create & work with a Checkbox field.","sidebar":"tutorialSidebar"},"fields/field-types/select-based/multi-select":{"id":"fields/field-types/select-based/multi-select","title":"Multi Select","description":"This article explains how to create & work with a Multi select field.","sidebar":"tutorialSidebar"},"fields/field-types/select-based/rating":{"id":"fields/field-types/select-based/rating","title":"Rating","description":"This article explains how to create & work with a Rating field.","sidebar":"tutorialSidebar"},"fields/field-types/select-based/single-select":{"id":"fields/field-types/select-based/single-select","title":"Single Select","description":"This article explains how to create & work with a Single select field.","sidebar":"tutorialSidebar"},"fields/field-types/text-based/email":{"id":"fields/field-types/text-based/email","title":"Email","description":"This article explains how to create & work with an Email field.","sidebar":"tutorialSidebar"},"fields/field-types/text-based/long-text":{"id":"fields/field-types/text-based/long-text","title":"Long text","description":"This article explains how to create & work with a Long text field.","sidebar":"tutorialSidebar"},"fields/field-types/text-based/phonenumber":{"id":"fields/field-types/text-based/phonenumber","title":"Phone Number","description":"This article explains how to create & work with a Phone number field.","sidebar":"tutorialSidebar"},"fields/field-types/text-based/single-line-text":{"id":"fields/field-types/text-based/single-line-text","title":"Single line text","description":"This article explains how to create & work with a Single line text field.","sidebar":"tutorialSidebar"},"fields/field-types/text-based/url":{"id":"fields/field-types/text-based/url","title":"URL","description":"This article explains how to create & work with an URL field.","sidebar":"tutorialSidebar"},"fields/fields-overview":{"id":"fields/fields-overview","title":"Fields overview","description":"This article discusses various field types that NocoDB offers.","sidebar":"tutorialSidebar"},"fields/multi-fields-editor":{"id":"fields/multi-fields-editor","title":"Multi-field editor","description":"Understanding use of multi-field editor in NocoDB!","sidebar":"tutorialSidebar"},"fields/primary-key":{"id":"fields/primary-key","title":"Primary key","description":"This article explains what a primary key is and how it is used in NocoDB.","sidebar":"tutorialSidebar"},"getting-started/keyboard-shortcuts":{"id":"getting-started/keyboard-shortcuts","title":"Keyboard shortcuts","description":"Quick Actions","sidebar":"tutorialSidebar"},"getting-started/quick-start":{"id":"getting-started/quick-start","title":"Quick start","description":"NocoDB offers you the flexibility of two distinct variants: self-hosted and SaaS (cloud-hosted). In this section, we\'ll walk you through the initial steps to embark on your NocoDB journey, whether you choose to set it up on your own infrastructure or opt for the convenience of our cloud-hosted service. Let\'s dive in and unlock the potential of NocoDB for your data management needs.","sidebar":"tutorialSidebar"},"getting-started/self-hosted/environment-variables":{"id":"getting-started/self-hosted/environment-variables","title":"Environment variables","description":"Environment Variables for NocoDB!","sidebar":"tutorialSidebar"},"getting-started/self-hosted/installation":{"id":"getting-started/self-hosted/installation","title":"Installation","description":"Simple installation - takes about three minutes!","sidebar":"tutorialSidebar"},"getting-started/self-hosted/upgrading":{"id":"getting-started/self-hosted/upgrading","title":"Upgrading","description":"Upgrading NocoDB : Docker, Node and Homebrew!","sidebar":"tutorialSidebar"},"getting-started/terminologies":{"id":"getting-started/terminologies","title":"NocoDB terminologies","description":"To maximize your use of NocoDB, it\'s beneficial to become familiar with some common terms.","sidebar":"tutorialSidebar"},"index":{"id":"index","title":"Welcome","description":"NocoDB Documentation","sidebar":"tutorialSidebar"},"records/actions-on-record":{"id":"records/actions-on-record","title":"Actions on record","description":"Learn how to perform actions (edit, duplicate, delete, etc) on a record in NocoDB.","sidebar":"tutorialSidebar"},"records/create-record":{"id":"records/create-record","title":"Create record","description":"Learn how to create a record in NocoDB.","sidebar":"tutorialSidebar"},"records/expand-record":{"id":"records/expand-record","title":"Expanded record","description":"Learn how to expand a record & work with it in NocoDB.","sidebar":"tutorialSidebar"},"records/records-overview":{"id":"records/records-overview","title":"Records overview","description":"Learn how to create, import, and manage records in NocoDB.","sidebar":"tutorialSidebar"},"roles-and-permissions/roles-permissions-overview":{"id":"roles-and-permissions/roles-permissions-overview","title":"Roles & permissions overview","description":"Learn about roles and permissions in NocoDB.","sidebar":"tutorialSidebar"},"table-details/table-details-overview":{"id":"table-details/table-details-overview","title":"Table details overview","description":"Table details overview","sidebar":"tutorialSidebar"},"table-operations/download":{"id":"table-operations/download","title":"Download","description":"NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.","sidebar":"tutorialSidebar"},"table-operations/field-operations":{"id":"table-operations/field-operations","title":"Hide & reorder fields","description":"Learn how to hide and reorder fields in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/filter":{"id":"table-operations/filter","title":"Filtering records","description":"Learn how to filter records in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/group-by":{"id":"table-operations/group-by","title":"Grouping records","description":"Learn how to group records in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/overview":{"id":"table-operations/overview","title":"Table operations overview","description":"Learn how to work with filters, sort, group by, and more in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/row-height":{"id":"table-operations/row-height","title":"Record height","description":"Learn how to adjust the height of records in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/search":{"id":"table-operations/search","title":"Search","description":"Learn how to search for records in NocoDB.","sidebar":"tutorialSidebar"},"table-operations/sort":{"id":"table-operations/sort","title":"Sorting records","description":"Learn how to sort records in NocoDB.","sidebar":"tutorialSidebar"},"tables/actions-on-table":{"id":"tables/actions-on-table","title":"Actions on table","description":"Learn how to rename, duplicate, and delete a table in NocoDB.","sidebar":"tutorialSidebar"},"tables/create-table":{"id":"tables/create-table","title":"Create empty table","description":"Learn how to create a table in NocoDB.","sidebar":"tutorialSidebar"},"tables/create-table-via-import":{"id":"tables/create-table-via-import","title":"Create table via import","description":"Learn how to create a table in NocoDB via import from CSV, Excel or JSON.","sidebar":"tutorialSidebar"},"tables/import-data-into-existing-table":{"id":"tables/import-data-into-existing-table","title":"Import data into an existing table","description":"Learn how to import data into an existing table in NocoDB.","sidebar":"tutorialSidebar"},"tables/table-overview":{"id":"tables/table-overview","title":"Table overview","description":"Learn how to create, import, and manage tables in NocoDB.","sidebar":"tutorialSidebar"},"views/actions-on-view":{"id":"views/actions-on-view","title":"Actions on view","description":"Learn how to delete, rename, duplicate a a view in NocoDB.","sidebar":"tutorialSidebar"},"views/create-view":{"id":"views/create-view","title":"Create view","description":"Learn how to create a new view in NocoDB.","sidebar":"tutorialSidebar"},"views/share-view":{"id":"views/share-view","title":"Share view","description":"Learn how to share a view publicly in NocoDB.","sidebar":"tutorialSidebar"},"views/view-types/form":{"id":"views/view-types/form","title":"Form","description":"Learn how to create, import, and manage forms in NocoDB.","sidebar":"tutorialSidebar"},"views/view-types/gallery":{"id":"views/view-types/gallery","title":"Gallery","description":"Learn how to work with gallery view in NocoDB.","sidebar":"tutorialSidebar"},"views/view-types/grid":{"id":"views/view-types/grid","title":"Grid","description":"Learn how to work with grid view in NocoDB.","sidebar":"tutorialSidebar"},"views/view-types/kanban":{"id":"views/view-types/kanban","title":"Kanban","description":"Learn how to work with kanban view in NocoDB.","sidebar":"tutorialSidebar"},"views/views-overview":{"id":"views/views-overview","title":"View overview","description":"Understanding Views in NocoDB!","sidebar":"tutorialSidebar"},"workspaces/actions-on-workspace":{"id":"workspaces/actions-on-workspace","title":"Actions on workspace","description":"This article explains how to rename or delete a workspace.","sidebar":"tutorialSidebar"},"workspaces/create-workspace":{"id":"workspaces/create-workspace","title":"Create workspace","description":"Learn how to create a workspace in NocoDB","sidebar":"tutorialSidebar"},"workspaces/workspace-collaboration":{"id":"workspaces/workspace-collaboration","title":"Workspace collaboration","description":"This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.","sidebar":"tutorialSidebar"},"workspaces/workspace-overview":{"id":"workspaces/workspace-overview","title":"Workspace overview","description":"This article briefs the concept of workspaces in NocoDB.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/packages/noco-docs/dist/assets/js/runtime~main.89e98ddf.js b/packages/noco-docs/dist/assets/js/runtime~main.da55b9eb.js similarity index 99% rename from packages/noco-docs/dist/assets/js/runtime~main.89e98ddf.js rename to packages/noco-docs/dist/assets/js/runtime~main.da55b9eb.js index b1cc4f79f0..1329a28704 100644 --- a/packages/noco-docs/dist/assets/js/runtime~main.89e98ddf.js +++ b/packages/noco-docs/dist/assets/js/runtime~main.da55b9eb.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,b,c,f,d={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var b=t[e]={id:e,loaded:!1,exports:{}};return d[e].call(b.exports,b,b.exports,r),b.loaded=!0,b.exports}r.m=d,r.c=t,e=[],r.O=(a,b,c,f)=>{if(!b){var d=1/0;for(i=0;i=f)&&Object.keys(r.O).every((e=>r.O[e](b[o])))?b.splice(o--,1):(t=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[b,c,f]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},b=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var d={};a=a||[null,b({}),b([]),b(b)];for(var t=2&c&&e;"object"==typeof t&&!~a.indexOf(t);t=b(t))Object.getOwnPropertyNames(t).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,r.d(f,d),f},r.d=(e,a)=>{for(var b in a)r.o(a,b)&&!r.o(e,b)&&Object.defineProperty(e,b,{enumerable:!0,get:a[b]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,b)=>(r.f[b](e,a),a)),[])),r.u=e=>"assets/js/"+({8:"2556c3eb",43:"01865ba3",53:"935f2afb",65:"16d5baaf",92:"c42aaec2",117:"0ecc5e11",254:"6d2f78d9",274:"b65801cb",305:"86fc9284",332:"70424118",333:"d69d4db4",345:"b3347e58",346:"ebb99180",403:"2b263996",405:"20e10381",481:"9db7fbd6",485:"cd3c4207",604:"0c130525",636:"c1a34d6e",678:"615746d5",753:"9329f711",757:"0b819d8c",771:"e68614dc",800:"cd725ea4",809:"0a7c5cbc",853:"f6aad64f",924:"71f80183",949:"775b7682",1015:"006c1c22",1067:"fb5c685c",1120:"e3120721",1140:"1970c274",1174:"95677701",1179:"35af5afe",1185:"00aa88f5",1193:"7dce83b4",1196:"985d43d9",1205:"d5451361",1245:"2cbe0325",1305:"0834b429",1313:"e302cfc9",1371:"013b8728",1416:"fb12fd2d",1461:"c76e097b",1471:"3721b01f",1484:"023320c3",1499:"81862c4f",1576:"dc1c5b3c",1590:"0b97ee01",1635:"e8cbe097",1641:"bb53f532",1676:"b6006dd7",1705:"d94fff3f",1730:"4cd0de40",1753:"4ed1386c",1771:"2bb712de",1796:"22580739",1802:"55156658",1876:"2eb4ec02",1878:"310a23cf",1944:"5eaf3a75",1949:"cc44517e",1961:"9a7e4ef7",1990:"10779e77",2092:"0d8de604",2237:"458ed5bd",2289:"275c23cd",2384:"b2206ab4",2406:"44655909",2439:"276e2b0f",2533:"3a7c0cf6",2534:"300d0b41",2550:"a47b7f3a",2556:"278121a5",2562:"224f2b0f",2582:"d96af704",2606:"bd02e23f",2636:"2a42d1d2",2642:"324eab63",2650:"55403ccd",2673:"78ec2f26",2773:"b22d161b",2776:"fe112e79",2862:"f0eb83f3",2874:"c2accac3",2922:"4f577b60",3011:"6f7695df",3062:"9a52cc21",3151:"aa1c05f4",3164:"58354ae8",3185:"a43060c8",3238:"27b20541",3259:"2888903d",3312:"a7294da8",3338:"3da8114c",3381:"8498c216",3447:"d3abb5b7",3454:"69bee932",3463:"60b8b995",3469:"525fa7b4",3479:"0cab3fcc",3512:"3aad05b1",3515:"3ac80ba6",3521:"f9241299",3590:"3615d78a",3595:"052c7f5b",3751:"3720c009",3755:"4efb7b3c",3845:"83cf658d",3857:"b7abf355",3869:"69bed9e5",3878:"83533542",3914:"df59b4b5",3939:"5436f7e6",3998:"7ce1d842",4021:"709f8fcb",4033:"5ccd3149",4121:"55960ee5",4158:"6a0eac6b",4166:"c1dfffdd",4177:"7e18769a",4193:"88cc213e",4223:"7a733070",4289:"69895f00",4304:"45c1aab2",4307:"99f674e5",4333:"9d4ed5ff",4341:"e55064b4",4364:"34b71ab6",4507:"87e9af65",4513:"c7dc53b4",4570:"824dfda1",4660:"c93390fb",4743:"d767d123",4769:"9aad2067",4796:"1e403fb7",4815:"70efa42e",4829:"2a1ace55",4851:"eb689018",4882:"da4f93ee",4918:"147f12f7",4936:"09ceb1a0",5017:"7d5d7de6",5055:"e631982f",5150:"524f61e0",5187:"5c9cf4c7",5207:"4bab5100",5221:"d65a8f51",5228:"cc9fede1",5305:"0ac1e38e",5334:"cb2030df",5336:"11d84c26",5375:"23371042",5381:"f4191957",5404:"1b14dca8",5407:"fb60c522",5408:"105fb6bf",5413:"d427e024",5518:"1c2ab191",5580:"7c4b6d90",5631:"2c8a1eac",5650:"e11b3e19",5707:"0bd8cdc6",5772:"576905f1",5822:"0f4f52c0",5837:"2d8eea4e",5922:"14095bfc",5971:"7077aad6",6078:"6502d10a",6090:"9db0d30f",6125:"ec135315",6141:"855d76bb",6157:"0f6b8098",6187:"0908b333",6263:"e4367861",6325:"4c6b0ee7",6570:"03af2c79",6591:"61a3d417",6640:"6485a1bf",6713:"abbfc25c",6714:"ae9857c7",6779:"ba1d2c5b",6786:"181f370e",6799:"31befc1e",6844:"468275e6",6859:"e68e0fff",6907:"22aab9a3",6928:"a18f2535",6999:"9e1a113d",7023:"90e43058",7026:"0aea064e",7075:"0938fe36",7096:"c1501dcb",7130:"31f9cd1a",7152:"529c2981",7219:"6fe2a298",7235:"f9538193",7283:"e5a54c1b",7395:"5dcc9f57",7530:"4145e2b1",7539:"14d6025d",7549:"68fa8000",7592:"6a105426",7621:"61af7884",7647:"6233b6dc",7657:"052736b6",7661:"9906c9d3",7666:"2d5bd7a1",7700:"603e048e",7746:"f7d905ba",7820:"037e2c34",7823:"9e7567e1",7918:"17896441",7920:"1a4e3797",8e3:"e4e12989",8149:"1b3738fb",8248:"408139c4",8252:"177ad845",8379:"d9e65f56",8381:"9c78149d",8395:"52df1fbb",8466:"cfe1d2b7",8511:"9040003c",8535:"6aee45b4",8537:"6a2ab9d1",8704:"1e898359",8750:"a9993c14",8789:"25ad7bcb",8820:"d01bd8c5",8838:"5af3a857",8880:"e28b0c4f",8916:"8f10bd27",8946:"10b0edf0",8954:"71540999",8958:"b444d910",9020:"1fb5f022",9042:"a15cb612",9060:"8a8a6f17",9069:"e56fdc78",9123:"f4472a32",9214:"f472468a",9279:"9dfd9b1b",9383:"a71ccd0b",9449:"18c96d41",9485:"fc37d7fe",9508:"523749b8",9514:"1be78505",9518:"95a14fd1",9542:"319e5695",9552:"2226a1e9",9554:"e12d67b0",9677:"2f81bee2",9693:"44eb4aec",9707:"ae730630",9721:"bb516362",9789:"32e0f401",9850:"9995b2be",9868:"ded49de4",9874:"832fc58a",9893:"98de4c79",9924:"df203c0f",9933:"654123f4"}[e]||e)+"."+{8:"608541f9",43:"4549ac36",53:"56686250",65:"80752d89",92:"c3eaeb58",117:"64d354f8",118:"1d6360db",254:"7e42a82e",274:"33fd730a",305:"a1a65b52",332:"3dfed9c1",333:"b43b4016",345:"cdcb3b32",346:"69344f2a",403:"998143cf",405:"8bd204da",481:"df4b0b95",485:"f4ac9c87",604:"033f7aac",636:"84dde03c",678:"b0727925",753:"4f19abf4",757:"0e797db3",771:"3109c382",800:"d30f312a",809:"cdcb8e4d",853:"d7381bfa",924:"484d6afc",949:"558cd548",1015:"c0ac510b",1067:"a9e94066",1120:"4cd01eb7",1140:"334059b6",1144:"8045f07e",1174:"42b2bf38",1179:"be900cd3",1185:"ece547d6",1193:"530372e4",1196:"74530544",1205:"2c2752cf",1245:"1df6cf91",1305:"d504b7b1",1313:"d9580788",1371:"00dc75b7",1416:"7f3d8a16",1461:"cb2c6722",1471:"84024fe5",1484:"23325e99",1499:"a3dbfbec",1576:"db40eb4b",1590:"9be26952",1635:"45e6f0b3",1641:"4d434c9f",1676:"ba122014",1705:"a6583a34",1730:"8614d0f0",1753:"bd3a0126",1771:"1b68f9cc",1796:"f7eb21e2",1802:"9adabe0f",1876:"1f2592f8",1878:"a5f0acab",1944:"f80b26bd",1949:"04005ed9",1961:"774c04a9",1990:"f565d9f8",2092:"0a26d9d5",2237:"2b599050",2289:"760a8cbe",2384:"4ae837f6",2406:"dc56ede0",2439:"605c6d82",2533:"494bacc8",2534:"62cb6499",2550:"8d81acfc",2556:"629b0435",2562:"9484385a",2582:"abc5835c",2606:"e789a668",2636:"2b1dab84",2642:"279737a1",2650:"7e8b474f",2664:"2f6568eb",2673:"dd1ac6e9",2773:"b9dc16ef",2776:"e62e8f04",2862:"c613762a",2874:"f65740b4",2922:"9bdd01f1",3011:"379c6147",3062:"0dd1507a",3151:"378a4f82",3164:"85a279e2",3185:"ee2e4b77",3238:"629af8e5",3259:"9bd1bb79",3312:"f960e7b6",3338:"0474e88b",3381:"483f8889",3447:"3e76ca95",3454:"66b73e69",3463:"008d5a3e",3469:"7415cceb",3479:"a26e8fb8",3512:"f2381f8b",3515:"bb7b70c4",3521:"0971d38c",3590:"3807e0ad",3595:"c97b212d",3751:"99c8d2d6",3755:"e1f85cdf",3845:"6228d6ec",3857:"93264657",3869:"d9e8352d",3878:"208d10be",3914:"91ec2734",3939:"ae12cb28",3998:"42879389",4021:"280a5e25",4033:"73f6caf1",4121:"9505d06b",4158:"e4313a7a",4166:"09a49a06",4177:"abb76911",4193:"37ccf1de",4223:"20b3d10c",4248:"06b3a45d",4289:"d201c760",4304:"6b478386",4307:"2881324c",4333:"35c99d38",4341:"f6b45318",4364:"001a0e94",4496:"40495c0d",4507:"48fa1223",4513:"b2f49337",4570:"9af56b1b",4660:"fed1f975",4743:"35c7072a",4769:"54a4562f",4796:"960437d1",4815:"177ad6fa",4829:"e7541d41",4851:"3b279b4e",4882:"15205e4b",4918:"12c002ab",4936:"051f7a95",5017:"b3fd985c",5055:"bf2deaa3",5150:"b0cdc102",5187:"125f1c65",5207:"4d7693a9",5221:"3fc6745d",5228:"611038ee",5305:"79289da6",5334:"3cfcfbf0",5336:"62b7c503",5375:"6595ff54",5381:"788dba4e",5404:"333819cc",5407:"cccea2fd",5408:"d4c7b2c6",5413:"48b2c64a",5518:"32696376",5580:"1548a3a9",5631:"98d5b5f9",5650:"33ad4247",5707:"7335a712",5772:"68b66089",5822:"8653bf6a",5837:"8c1789a5",5922:"09f9422f",5971:"2c994371",6078:"62d3ac16",6090:"4b7b42d4",6125:"b4b6192c",6141:"e625ba60",6157:"784442da",6187:"4c4be206",6263:"d460a6d1",6325:"a1efd9aa",6570:"3092a9bd",6591:"e845dc89",6640:"4bdbdd94",6713:"8291f979",6714:"492b458b",6758:"0b60db9c",6779:"231d6b55",6786:"86d7ec4e",6799:"cf53cc0e",6844:"fec8c4ba",6859:"ebde1054",6907:"c0e16b59",6928:"2f4e7484",6999:"31b44444",7023:"f9839c0b",7026:"44552b5a",7075:"9d5f346a",7096:"9f4cc897",7130:"775da14b",7152:"677765b3",7219:"b467aef4",7235:"9c7eadce",7283:"6ee5594a",7395:"d3132ef5",7530:"c42db197",7539:"cce9c4f9",7549:"a2b38347",7592:"d17cfd2e",7621:"3fcf73eb",7647:"7caaef91",7657:"c43758e0",7661:"22de1286",7666:"a60bd427",7700:"2cc120ec",7746:"ac350311",7820:"5bd7ff52",7823:"fa0b282d",7918:"a1973732",7920:"23399ed0",8e3:"d9cb26c6",8149:"ad6025e7",8248:"6b2f2ba2",8252:"b0dd41ef",8379:"f4c9b0b5",8381:"29a2e4eb",8395:"ee608d54",8466:"e157c52a",8511:"21ca2128",8535:"3a6ca145",8537:"b209bc54",8704:"49fc3451",8750:"d9ac97ff",8789:"4e828725",8820:"e0aecdfc",8838:"77b6f910",8880:"752cc726",8916:"f42b91e2",8946:"7e378df6",8954:"b733bdbe",8958:"aba4d313",9020:"2932790c",9042:"f7f99640",9059:"f590360f",9060:"b9888edf",9069:"daaabb90",9123:"dd919c72",9214:"5dd0bcc4",9279:"066e94eb",9383:"d3daa956",9449:"d9743a27",9485:"55f2b5bf",9508:"09bf2be9",9514:"257bb2d5",9518:"51597f7e",9542:"606ef121",9552:"03795cf8",9554:"19f1f2d2",9677:"3ffbdb86",9693:"a24387e7",9707:"b54065e8",9721:"091774e0",9789:"c4f99129",9850:"987e5cba",9868:"41121548",9874:"ea2a063d",9893:"ccac5542",9924:"9abfc930",9933:"09f2f089",9964:"777c14c3"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),c={},f="noco-docs:",r.l=(e,a,b,d)=>{if(c[e])c[e].push(a);else{var t,o;if(void 0!==b)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var f=c[e];if(delete c[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((e=>e(b))),a)return a(b)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/",r.gca=function(e){return e={17896441:"7918",22580739:"1796",23371042:"5375",44655909:"2406",55156658:"1802",70424118:"332",71540999:"8954",83533542:"3878",95677701:"1174","2556c3eb":"8","01865ba3":"43","935f2afb":"53","16d5baaf":"65",c42aaec2:"92","0ecc5e11":"117","6d2f78d9":"254",b65801cb:"274","86fc9284":"305",d69d4db4:"333",b3347e58:"345",ebb99180:"346","2b263996":"403","20e10381":"405","9db7fbd6":"481",cd3c4207:"485","0c130525":"604",c1a34d6e:"636","615746d5":"678","9329f711":"753","0b819d8c":"757",e68614dc:"771",cd725ea4:"800","0a7c5cbc":"809",f6aad64f:"853","71f80183":"924","775b7682":"949","006c1c22":"1015",fb5c685c:"1067",e3120721:"1120","1970c274":"1140","35af5afe":"1179","00aa88f5":"1185","7dce83b4":"1193","985d43d9":"1196",d5451361:"1205","2cbe0325":"1245","0834b429":"1305",e302cfc9:"1313","013b8728":"1371",fb12fd2d:"1416",c76e097b:"1461","3721b01f":"1471","023320c3":"1484","81862c4f":"1499",dc1c5b3c:"1576","0b97ee01":"1590",e8cbe097:"1635",bb53f532:"1641",b6006dd7:"1676",d94fff3f:"1705","4cd0de40":"1730","4ed1386c":"1753","2bb712de":"1771","2eb4ec02":"1876","310a23cf":"1878","5eaf3a75":"1944",cc44517e:"1949","9a7e4ef7":"1961","10779e77":"1990","0d8de604":"2092","458ed5bd":"2237","275c23cd":"2289",b2206ab4:"2384","276e2b0f":"2439","3a7c0cf6":"2533","300d0b41":"2534",a47b7f3a:"2550","278121a5":"2556","224f2b0f":"2562",d96af704:"2582",bd02e23f:"2606","2a42d1d2":"2636","324eab63":"2642","55403ccd":"2650","78ec2f26":"2673",b22d161b:"2773",fe112e79:"2776",f0eb83f3:"2862",c2accac3:"2874","4f577b60":"2922","6f7695df":"3011","9a52cc21":"3062",aa1c05f4:"3151","58354ae8":"3164",a43060c8:"3185","27b20541":"3238","2888903d":"3259",a7294da8:"3312","3da8114c":"3338","8498c216":"3381",d3abb5b7:"3447","69bee932":"3454","60b8b995":"3463","525fa7b4":"3469","0cab3fcc":"3479","3aad05b1":"3512","3ac80ba6":"3515",f9241299:"3521","3615d78a":"3590","052c7f5b":"3595","3720c009":"3751","4efb7b3c":"3755","83cf658d":"3845",b7abf355:"3857","69bed9e5":"3869",df59b4b5:"3914","5436f7e6":"3939","7ce1d842":"3998","709f8fcb":"4021","5ccd3149":"4033","55960ee5":"4121","6a0eac6b":"4158",c1dfffdd:"4166","7e18769a":"4177","88cc213e":"4193","7a733070":"4223","69895f00":"4289","45c1aab2":"4304","99f674e5":"4307","9d4ed5ff":"4333",e55064b4:"4341","34b71ab6":"4364","87e9af65":"4507",c7dc53b4:"4513","824dfda1":"4570",c93390fb:"4660",d767d123:"4743","9aad2067":"4769","1e403fb7":"4796","70efa42e":"4815","2a1ace55":"4829",eb689018:"4851",da4f93ee:"4882","147f12f7":"4918","09ceb1a0":"4936","7d5d7de6":"5017",e631982f:"5055","524f61e0":"5150","5c9cf4c7":"5187","4bab5100":"5207",d65a8f51:"5221",cc9fede1:"5228","0ac1e38e":"5305",cb2030df:"5334","11d84c26":"5336",f4191957:"5381","1b14dca8":"5404",fb60c522:"5407","105fb6bf":"5408",d427e024:"5413","1c2ab191":"5518","7c4b6d90":"5580","2c8a1eac":"5631",e11b3e19:"5650","0bd8cdc6":"5707","576905f1":"5772","0f4f52c0":"5822","2d8eea4e":"5837","14095bfc":"5922","7077aad6":"5971","6502d10a":"6078","9db0d30f":"6090",ec135315:"6125","855d76bb":"6141","0f6b8098":"6157","0908b333":"6187",e4367861:"6263","4c6b0ee7":"6325","03af2c79":"6570","61a3d417":"6591","6485a1bf":"6640",abbfc25c:"6713",ae9857c7:"6714",ba1d2c5b:"6779","181f370e":"6786","31befc1e":"6799","468275e6":"6844",e68e0fff:"6859","22aab9a3":"6907",a18f2535:"6928","9e1a113d":"6999","90e43058":"7023","0aea064e":"7026","0938fe36":"7075",c1501dcb:"7096","31f9cd1a":"7130","529c2981":"7152","6fe2a298":"7219",f9538193:"7235",e5a54c1b:"7283","5dcc9f57":"7395","4145e2b1":"7530","14d6025d":"7539","68fa8000":"7549","6a105426":"7592","61af7884":"7621","6233b6dc":"7647","052736b6":"7657","9906c9d3":"7661","2d5bd7a1":"7666","603e048e":"7700",f7d905ba:"7746","037e2c34":"7820","9e7567e1":"7823","1a4e3797":"7920",e4e12989:"8000","1b3738fb":"8149","408139c4":"8248","177ad845":"8252",d9e65f56:"8379","9c78149d":"8381","52df1fbb":"8395",cfe1d2b7:"8466","9040003c":"8511","6aee45b4":"8535","6a2ab9d1":"8537","1e898359":"8704",a9993c14:"8750","25ad7bcb":"8789",d01bd8c5:"8820","5af3a857":"8838",e28b0c4f:"8880","8f10bd27":"8916","10b0edf0":"8946",b444d910:"8958","1fb5f022":"9020",a15cb612:"9042","8a8a6f17":"9060",e56fdc78:"9069",f4472a32:"9123",f472468a:"9214","9dfd9b1b":"9279",a71ccd0b:"9383","18c96d41":"9449",fc37d7fe:"9485","523749b8":"9508","1be78505":"9514","95a14fd1":"9518","319e5695":"9542","2226a1e9":"9552",e12d67b0:"9554","2f81bee2":"9677","44eb4aec":"9693",ae730630:"9707",bb516362:"9721","32e0f401":"9789","9995b2be":"9850",ded49de4:"9868","832fc58a":"9874","98de4c79":"9893",df203c0f:"9924","654123f4":"9933"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,b)=>{var c=r.o(e,a)?e[a]:void 0;if(0!==c)if(c)b.push(c[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((b,f)=>c=e[a]=[b,f]));b.push(c[2]=f);var d=r.p+r.u(a),t=new Error;r.l(d,(b=>{if(r.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var f=b&&("load"===b.type?"missing":b.type),d=b&&b.target&&b.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",t.name="ChunkLoadError",t.type=f,t.request=d,c[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,b)=>{var c,f,d=b[0],t=b[1],o=b[2],n=0;if(d.some((a=>0!==e[a]))){for(c in t)r.o(t,c)&&(r.m[c]=t[c]);if(o)var i=o(r)}for(a&&a(b);n{"use strict";var e,a,b,c,f,d={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var b=t[e]={id:e,loaded:!1,exports:{}};return d[e].call(b.exports,b,b.exports,r),b.loaded=!0,b.exports}r.m=d,r.c=t,e=[],r.O=(a,b,c,f)=>{if(!b){var d=1/0;for(i=0;i=f)&&Object.keys(r.O).every((e=>r.O[e](b[o])))?b.splice(o--,1):(t=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[b,c,f]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},b=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var d={};a=a||[null,b({}),b([]),b(b)];for(var t=2&c&&e;"object"==typeof t&&!~a.indexOf(t);t=b(t))Object.getOwnPropertyNames(t).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,r.d(f,d),f},r.d=(e,a)=>{for(var b in a)r.o(a,b)&&!r.o(e,b)&&Object.defineProperty(e,b,{enumerable:!0,get:a[b]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,b)=>(r.f[b](e,a),a)),[])),r.u=e=>"assets/js/"+({8:"2556c3eb",43:"01865ba3",53:"935f2afb",65:"16d5baaf",92:"c42aaec2",117:"0ecc5e11",254:"6d2f78d9",274:"b65801cb",305:"86fc9284",332:"70424118",333:"d69d4db4",345:"b3347e58",346:"ebb99180",403:"2b263996",405:"20e10381",481:"9db7fbd6",485:"cd3c4207",604:"0c130525",636:"c1a34d6e",678:"615746d5",753:"9329f711",757:"0b819d8c",771:"e68614dc",800:"cd725ea4",809:"0a7c5cbc",853:"f6aad64f",924:"71f80183",949:"775b7682",1015:"006c1c22",1067:"fb5c685c",1120:"e3120721",1140:"1970c274",1174:"95677701",1179:"35af5afe",1185:"00aa88f5",1193:"7dce83b4",1196:"985d43d9",1205:"d5451361",1245:"2cbe0325",1305:"0834b429",1313:"e302cfc9",1371:"013b8728",1416:"fb12fd2d",1461:"c76e097b",1471:"3721b01f",1484:"023320c3",1499:"81862c4f",1576:"dc1c5b3c",1590:"0b97ee01",1635:"e8cbe097",1641:"bb53f532",1676:"b6006dd7",1705:"d94fff3f",1730:"4cd0de40",1753:"4ed1386c",1771:"2bb712de",1796:"22580739",1802:"55156658",1876:"2eb4ec02",1878:"310a23cf",1944:"5eaf3a75",1949:"cc44517e",1961:"9a7e4ef7",1990:"10779e77",2092:"0d8de604",2237:"458ed5bd",2289:"275c23cd",2384:"b2206ab4",2406:"44655909",2439:"276e2b0f",2533:"3a7c0cf6",2534:"300d0b41",2550:"a47b7f3a",2556:"278121a5",2562:"224f2b0f",2582:"d96af704",2606:"bd02e23f",2636:"2a42d1d2",2642:"324eab63",2650:"55403ccd",2673:"78ec2f26",2773:"b22d161b",2776:"fe112e79",2862:"f0eb83f3",2874:"c2accac3",2922:"4f577b60",3011:"6f7695df",3062:"9a52cc21",3151:"aa1c05f4",3164:"58354ae8",3185:"a43060c8",3238:"27b20541",3259:"2888903d",3312:"a7294da8",3338:"3da8114c",3381:"8498c216",3447:"d3abb5b7",3454:"69bee932",3463:"60b8b995",3469:"525fa7b4",3479:"0cab3fcc",3512:"3aad05b1",3515:"3ac80ba6",3521:"f9241299",3590:"3615d78a",3595:"052c7f5b",3751:"3720c009",3755:"4efb7b3c",3845:"83cf658d",3857:"b7abf355",3869:"69bed9e5",3878:"83533542",3914:"df59b4b5",3939:"5436f7e6",3998:"7ce1d842",4021:"709f8fcb",4033:"5ccd3149",4121:"55960ee5",4158:"6a0eac6b",4166:"c1dfffdd",4177:"7e18769a",4193:"88cc213e",4223:"7a733070",4289:"69895f00",4304:"45c1aab2",4307:"99f674e5",4333:"9d4ed5ff",4341:"e55064b4",4364:"34b71ab6",4507:"87e9af65",4513:"c7dc53b4",4570:"824dfda1",4660:"c93390fb",4743:"d767d123",4769:"9aad2067",4796:"1e403fb7",4815:"70efa42e",4829:"2a1ace55",4851:"eb689018",4882:"da4f93ee",4918:"147f12f7",4936:"09ceb1a0",5017:"7d5d7de6",5055:"e631982f",5150:"524f61e0",5187:"5c9cf4c7",5207:"4bab5100",5221:"d65a8f51",5228:"cc9fede1",5305:"0ac1e38e",5334:"cb2030df",5336:"11d84c26",5375:"23371042",5381:"f4191957",5404:"1b14dca8",5407:"fb60c522",5408:"105fb6bf",5413:"d427e024",5518:"1c2ab191",5580:"7c4b6d90",5631:"2c8a1eac",5650:"e11b3e19",5707:"0bd8cdc6",5772:"576905f1",5822:"0f4f52c0",5837:"2d8eea4e",5922:"14095bfc",5971:"7077aad6",6078:"6502d10a",6090:"9db0d30f",6125:"ec135315",6141:"855d76bb",6157:"0f6b8098",6187:"0908b333",6263:"e4367861",6325:"4c6b0ee7",6570:"03af2c79",6591:"61a3d417",6640:"6485a1bf",6713:"abbfc25c",6714:"ae9857c7",6779:"ba1d2c5b",6786:"181f370e",6799:"31befc1e",6844:"468275e6",6859:"e68e0fff",6907:"22aab9a3",6928:"a18f2535",6999:"9e1a113d",7023:"90e43058",7026:"0aea064e",7075:"0938fe36",7096:"c1501dcb",7130:"31f9cd1a",7152:"529c2981",7219:"6fe2a298",7235:"f9538193",7283:"e5a54c1b",7395:"5dcc9f57",7530:"4145e2b1",7539:"14d6025d",7549:"68fa8000",7592:"6a105426",7621:"61af7884",7647:"6233b6dc",7657:"052736b6",7661:"9906c9d3",7666:"2d5bd7a1",7700:"603e048e",7746:"f7d905ba",7820:"037e2c34",7823:"9e7567e1",7918:"17896441",7920:"1a4e3797",8e3:"e4e12989",8149:"1b3738fb",8248:"408139c4",8252:"177ad845",8379:"d9e65f56",8381:"9c78149d",8395:"52df1fbb",8466:"cfe1d2b7",8511:"9040003c",8535:"6aee45b4",8537:"6a2ab9d1",8704:"1e898359",8750:"a9993c14",8789:"25ad7bcb",8820:"d01bd8c5",8838:"5af3a857",8880:"e28b0c4f",8916:"8f10bd27",8946:"10b0edf0",8954:"71540999",8958:"b444d910",9020:"1fb5f022",9042:"a15cb612",9060:"8a8a6f17",9069:"e56fdc78",9123:"f4472a32",9214:"f472468a",9279:"9dfd9b1b",9383:"a71ccd0b",9449:"18c96d41",9485:"fc37d7fe",9508:"523749b8",9514:"1be78505",9518:"95a14fd1",9542:"319e5695",9552:"2226a1e9",9554:"e12d67b0",9677:"2f81bee2",9693:"44eb4aec",9707:"ae730630",9721:"bb516362",9789:"32e0f401",9850:"9995b2be",9868:"ded49de4",9874:"832fc58a",9893:"98de4c79",9924:"df203c0f",9933:"654123f4"}[e]||e)+"."+{8:"608541f9",43:"4549ac36",53:"db7a4e77",65:"80752d89",92:"c3eaeb58",117:"64d354f8",118:"1d6360db",254:"7e42a82e",274:"33fd730a",305:"a1a65b52",332:"3dfed9c1",333:"b43b4016",345:"cdcb3b32",346:"69344f2a",403:"998143cf",405:"8bd204da",481:"df4b0b95",485:"f4ac9c87",604:"033f7aac",636:"84dde03c",678:"b0727925",753:"4f19abf4",757:"0e797db3",771:"3109c382",800:"d30f312a",809:"cdcb8e4d",853:"d7381bfa",924:"484d6afc",949:"558cd548",1015:"c0ac510b",1067:"a9e94066",1120:"4cd01eb7",1140:"334059b6",1144:"8045f07e",1174:"42b2bf38",1179:"be900cd3",1185:"ece547d6",1193:"530372e4",1196:"74530544",1205:"2c2752cf",1245:"1df6cf91",1305:"d504b7b1",1313:"d9580788",1371:"00dc75b7",1416:"7f3d8a16",1461:"cb2c6722",1471:"84024fe5",1484:"23325e99",1499:"a3dbfbec",1576:"db40eb4b",1590:"9be26952",1635:"45e6f0b3",1641:"4d434c9f",1676:"ba122014",1705:"a6583a34",1730:"8614d0f0",1753:"bd3a0126",1771:"1b68f9cc",1796:"f7eb21e2",1802:"9adabe0f",1876:"1f2592f8",1878:"a5f0acab",1944:"f80b26bd",1949:"04005ed9",1961:"774c04a9",1990:"f565d9f8",2092:"0a26d9d5",2237:"2b599050",2289:"760a8cbe",2384:"4ae837f6",2406:"dc56ede0",2439:"605c6d82",2533:"494bacc8",2534:"62cb6499",2550:"8d81acfc",2556:"629b0435",2562:"9484385a",2582:"abc5835c",2606:"e789a668",2636:"2b1dab84",2642:"279737a1",2650:"7e8b474f",2664:"2f6568eb",2673:"dd1ac6e9",2773:"b9dc16ef",2776:"e62e8f04",2862:"c613762a",2874:"f65740b4",2922:"9bdd01f1",3011:"379c6147",3062:"0dd1507a",3151:"378a4f82",3164:"85a279e2",3185:"ee2e4b77",3238:"629af8e5",3259:"9bd1bb79",3312:"f960e7b6",3338:"0474e88b",3381:"483f8889",3447:"3e76ca95",3454:"66b73e69",3463:"008d5a3e",3469:"7415cceb",3479:"a26e8fb8",3512:"f2381f8b",3515:"bb7b70c4",3521:"0971d38c",3590:"3807e0ad",3595:"c97b212d",3751:"99c8d2d6",3755:"e1f85cdf",3845:"6228d6ec",3857:"93264657",3869:"d9e8352d",3878:"208d10be",3914:"91ec2734",3939:"ae12cb28",3998:"42879389",4021:"280a5e25",4033:"73f6caf1",4121:"9505d06b",4158:"e4313a7a",4166:"09a49a06",4177:"abb76911",4193:"37ccf1de",4223:"20b3d10c",4248:"06b3a45d",4289:"d201c760",4304:"6b478386",4307:"2881324c",4333:"35c99d38",4341:"f6b45318",4364:"001a0e94",4496:"40495c0d",4507:"48fa1223",4513:"b2f49337",4570:"9af56b1b",4660:"fed1f975",4743:"35c7072a",4769:"54a4562f",4796:"960437d1",4815:"177ad6fa",4829:"e7541d41",4851:"3b279b4e",4882:"15205e4b",4918:"12c002ab",4936:"051f7a95",5017:"b3fd985c",5055:"bf2deaa3",5150:"b0cdc102",5187:"125f1c65",5207:"4d7693a9",5221:"3fc6745d",5228:"611038ee",5305:"79289da6",5334:"3cfcfbf0",5336:"62b7c503",5375:"6595ff54",5381:"788dba4e",5404:"333819cc",5407:"cccea2fd",5408:"d4c7b2c6",5413:"48b2c64a",5518:"32696376",5580:"1548a3a9",5631:"98d5b5f9",5650:"33ad4247",5707:"7335a712",5772:"68b66089",5822:"8653bf6a",5837:"8c1789a5",5922:"09f9422f",5971:"2c994371",6078:"62d3ac16",6090:"4b7b42d4",6125:"b4b6192c",6141:"e625ba60",6157:"784442da",6187:"4c4be206",6263:"d460a6d1",6325:"a1efd9aa",6570:"3092a9bd",6591:"e845dc89",6640:"4bdbdd94",6713:"8291f979",6714:"492b458b",6758:"0b60db9c",6779:"231d6b55",6786:"86d7ec4e",6799:"cf53cc0e",6844:"fec8c4ba",6859:"ebde1054",6907:"c0e16b59",6928:"2f4e7484",6999:"31b44444",7023:"f9839c0b",7026:"44552b5a",7075:"9d5f346a",7096:"9f4cc897",7130:"775da14b",7152:"677765b3",7219:"b467aef4",7235:"9c7eadce",7283:"6ee5594a",7395:"d3132ef5",7530:"c42db197",7539:"cce9c4f9",7549:"a2b38347",7592:"d17cfd2e",7621:"3fcf73eb",7647:"7caaef91",7657:"c43758e0",7661:"22de1286",7666:"a60bd427",7700:"2cc120ec",7746:"ac350311",7820:"5bd7ff52",7823:"fa0b282d",7918:"a1973732",7920:"23399ed0",8e3:"d9cb26c6",8149:"ad6025e7",8248:"6b2f2ba2",8252:"b0dd41ef",8379:"f4c9b0b5",8381:"29a2e4eb",8395:"ee608d54",8466:"e157c52a",8511:"21ca2128",8535:"3a6ca145",8537:"b209bc54",8704:"49fc3451",8750:"d9ac97ff",8789:"4e828725",8820:"e0aecdfc",8838:"77b6f910",8880:"752cc726",8916:"f42b91e2",8946:"7e378df6",8954:"b733bdbe",8958:"aba4d313",9020:"2932790c",9042:"f7f99640",9059:"f590360f",9060:"b9888edf",9069:"daaabb90",9123:"dd919c72",9214:"5dd0bcc4",9279:"066e94eb",9383:"d3daa956",9449:"d9743a27",9485:"55f2b5bf",9508:"09bf2be9",9514:"257bb2d5",9518:"51597f7e",9542:"606ef121",9552:"03795cf8",9554:"19f1f2d2",9677:"3ffbdb86",9693:"a24387e7",9707:"b54065e8",9721:"091774e0",9789:"c4f99129",9850:"987e5cba",9868:"41121548",9874:"ea2a063d",9893:"ccac5542",9924:"9abfc930",9933:"09f2f089",9964:"777c14c3"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),c={},f="noco-docs:",r.l=(e,a,b,d)=>{if(c[e])c[e].push(a);else{var t,o;if(void 0!==b)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var f=c[e];if(delete c[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((e=>e(b))),a)return a(b)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/",r.gca=function(e){return e={17896441:"7918",22580739:"1796",23371042:"5375",44655909:"2406",55156658:"1802",70424118:"332",71540999:"8954",83533542:"3878",95677701:"1174","2556c3eb":"8","01865ba3":"43","935f2afb":"53","16d5baaf":"65",c42aaec2:"92","0ecc5e11":"117","6d2f78d9":"254",b65801cb:"274","86fc9284":"305",d69d4db4:"333",b3347e58:"345",ebb99180:"346","2b263996":"403","20e10381":"405","9db7fbd6":"481",cd3c4207:"485","0c130525":"604",c1a34d6e:"636","615746d5":"678","9329f711":"753","0b819d8c":"757",e68614dc:"771",cd725ea4:"800","0a7c5cbc":"809",f6aad64f:"853","71f80183":"924","775b7682":"949","006c1c22":"1015",fb5c685c:"1067",e3120721:"1120","1970c274":"1140","35af5afe":"1179","00aa88f5":"1185","7dce83b4":"1193","985d43d9":"1196",d5451361:"1205","2cbe0325":"1245","0834b429":"1305",e302cfc9:"1313","013b8728":"1371",fb12fd2d:"1416",c76e097b:"1461","3721b01f":"1471","023320c3":"1484","81862c4f":"1499",dc1c5b3c:"1576","0b97ee01":"1590",e8cbe097:"1635",bb53f532:"1641",b6006dd7:"1676",d94fff3f:"1705","4cd0de40":"1730","4ed1386c":"1753","2bb712de":"1771","2eb4ec02":"1876","310a23cf":"1878","5eaf3a75":"1944",cc44517e:"1949","9a7e4ef7":"1961","10779e77":"1990","0d8de604":"2092","458ed5bd":"2237","275c23cd":"2289",b2206ab4:"2384","276e2b0f":"2439","3a7c0cf6":"2533","300d0b41":"2534",a47b7f3a:"2550","278121a5":"2556","224f2b0f":"2562",d96af704:"2582",bd02e23f:"2606","2a42d1d2":"2636","324eab63":"2642","55403ccd":"2650","78ec2f26":"2673",b22d161b:"2773",fe112e79:"2776",f0eb83f3:"2862",c2accac3:"2874","4f577b60":"2922","6f7695df":"3011","9a52cc21":"3062",aa1c05f4:"3151","58354ae8":"3164",a43060c8:"3185","27b20541":"3238","2888903d":"3259",a7294da8:"3312","3da8114c":"3338","8498c216":"3381",d3abb5b7:"3447","69bee932":"3454","60b8b995":"3463","525fa7b4":"3469","0cab3fcc":"3479","3aad05b1":"3512","3ac80ba6":"3515",f9241299:"3521","3615d78a":"3590","052c7f5b":"3595","3720c009":"3751","4efb7b3c":"3755","83cf658d":"3845",b7abf355:"3857","69bed9e5":"3869",df59b4b5:"3914","5436f7e6":"3939","7ce1d842":"3998","709f8fcb":"4021","5ccd3149":"4033","55960ee5":"4121","6a0eac6b":"4158",c1dfffdd:"4166","7e18769a":"4177","88cc213e":"4193","7a733070":"4223","69895f00":"4289","45c1aab2":"4304","99f674e5":"4307","9d4ed5ff":"4333",e55064b4:"4341","34b71ab6":"4364","87e9af65":"4507",c7dc53b4:"4513","824dfda1":"4570",c93390fb:"4660",d767d123:"4743","9aad2067":"4769","1e403fb7":"4796","70efa42e":"4815","2a1ace55":"4829",eb689018:"4851",da4f93ee:"4882","147f12f7":"4918","09ceb1a0":"4936","7d5d7de6":"5017",e631982f:"5055","524f61e0":"5150","5c9cf4c7":"5187","4bab5100":"5207",d65a8f51:"5221",cc9fede1:"5228","0ac1e38e":"5305",cb2030df:"5334","11d84c26":"5336",f4191957:"5381","1b14dca8":"5404",fb60c522:"5407","105fb6bf":"5408",d427e024:"5413","1c2ab191":"5518","7c4b6d90":"5580","2c8a1eac":"5631",e11b3e19:"5650","0bd8cdc6":"5707","576905f1":"5772","0f4f52c0":"5822","2d8eea4e":"5837","14095bfc":"5922","7077aad6":"5971","6502d10a":"6078","9db0d30f":"6090",ec135315:"6125","855d76bb":"6141","0f6b8098":"6157","0908b333":"6187",e4367861:"6263","4c6b0ee7":"6325","03af2c79":"6570","61a3d417":"6591","6485a1bf":"6640",abbfc25c:"6713",ae9857c7:"6714",ba1d2c5b:"6779","181f370e":"6786","31befc1e":"6799","468275e6":"6844",e68e0fff:"6859","22aab9a3":"6907",a18f2535:"6928","9e1a113d":"6999","90e43058":"7023","0aea064e":"7026","0938fe36":"7075",c1501dcb:"7096","31f9cd1a":"7130","529c2981":"7152","6fe2a298":"7219",f9538193:"7235",e5a54c1b:"7283","5dcc9f57":"7395","4145e2b1":"7530","14d6025d":"7539","68fa8000":"7549","6a105426":"7592","61af7884":"7621","6233b6dc":"7647","052736b6":"7657","9906c9d3":"7661","2d5bd7a1":"7666","603e048e":"7700",f7d905ba:"7746","037e2c34":"7820","9e7567e1":"7823","1a4e3797":"7920",e4e12989:"8000","1b3738fb":"8149","408139c4":"8248","177ad845":"8252",d9e65f56:"8379","9c78149d":"8381","52df1fbb":"8395",cfe1d2b7:"8466","9040003c":"8511","6aee45b4":"8535","6a2ab9d1":"8537","1e898359":"8704",a9993c14:"8750","25ad7bcb":"8789",d01bd8c5:"8820","5af3a857":"8838",e28b0c4f:"8880","8f10bd27":"8916","10b0edf0":"8946",b444d910:"8958","1fb5f022":"9020",a15cb612:"9042","8a8a6f17":"9060",e56fdc78:"9069",f4472a32:"9123",f472468a:"9214","9dfd9b1b":"9279",a71ccd0b:"9383","18c96d41":"9449",fc37d7fe:"9485","523749b8":"9508","1be78505":"9514","95a14fd1":"9518","319e5695":"9542","2226a1e9":"9552",e12d67b0:"9554","2f81bee2":"9677","44eb4aec":"9693",ae730630:"9707",bb516362:"9721","32e0f401":"9789","9995b2be":"9850",ded49de4:"9868","832fc58a":"9874","98de4c79":"9893",df203c0f:"9924","654123f4":"9933"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,b)=>{var c=r.o(e,a)?e[a]:void 0;if(0!==c)if(c)b.push(c[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((b,f)=>c=e[a]=[b,f]));b.push(c[2]=f);var d=r.p+r.u(a),t=new Error;r.l(d,(b=>{if(r.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var f=b&&("load"===b.type?"missing":b.type),d=b&&b.target&&b.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",t.name="ChunkLoadError",t.type=f,t.request=d,c[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,b)=>{var c,f,d=b[0],t=b[1],o=b[2],n=0;if(d.some((a=>0!==e[a]))){for(c in t)r.o(t,c)&&(r.m[c]=t[c]);if(o)var i=o(r)}for(a&&a(b);n Actions on webhook | NocoDB - +
    -
    Version: Latest

    Actions on webhook

    Enable/disable Webhook​

    To disable a Webhook

    • Open Webhook tab to find list of webhooks created
    • Toggle Activate button to enable/disable

    Webhook List

    Edit Webhook​

    To edit a Webhook

    • Open Webhook tab to find list of webhooks created
    • Click on webhook to be edited
    • This will open up the webhook configuration page, which is similar to the page used for creating webhook. Reconfigure the webhook as required
    • Click on Save button to save the changes

    Duplicate Webhook​

    To duplicate a Webhook

    • Open Webhook tab to find list of webhooks created
    • Click on ... actions button associated with the webhook to be duplicate
    • Select Duplicate

    Webhook context menu

    A copy of the webhook will be created (disabled by default) with a suffix - Copy

    Delete Webhook​

    To delete a Webhook

    • Open Webhook tab to find list of webhooks created
    • Click on ... actions button associated with the webhook to be deleted
    • Select Delete

    Webhook context menu

    - +
    Version: Latest

    Actions on webhook

    Enable/disable Webhook​

    To disable a Webhook

    • Open Webhook tab to find list of webhooks created
    • Toggle Activate button to enable/disable

    Webhook List

    Edit Webhook​

    To edit a Webhook

    • Open Webhook tab to find list of webhooks created
    • Click on webhook to be edited
    • This will open up the webhook configuration page, which is similar to the page used for creating webhook. Reconfigure the webhook as required
    • Click on Save button to save the changes

    Duplicate Webhook​

    To duplicate a Webhook

    • Open Webhook tab to find list of webhooks created
    • Click on ... actions button associated with the webhook to be duplicate
    • Select Duplicate

    Webhook context menu

    A copy of the webhook will be created (disabled by default) with a suffix - Copy

    Delete Webhook​

    To delete a Webhook

    • Open Webhook tab to find list of webhooks created
    • Click on ... actions button associated with the webhook to be deleted
    • Select Delete

    Webhook context menu

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/automation/webhook/create-webhook/index.html b/packages/noco-docs/dist/automation/webhook/create-webhook/index.html index b3d2dbea61..d972d43368 100644 --- a/packages/noco-docs/dist/automation/webhook/create-webhook/index.html +++ b/packages/noco-docs/dist/automation/webhook/create-webhook/index.html @@ -4,13 +4,13 @@ Create webhook | NocoDB - +
    -
    Version: Latest

    Create webhook

    Create Webhook​

    Accessing webhook page​

    1. Click on table for which webhook needs to be configured on the left sidebar
    2. Open Details tab in topbar,
    3. Click on Webhooks tab
    4. Click Add New Webhook

    Accessing webhook

    Configuring webhook​

    1. Name of the webhook
    2. Select the event for which webhook needs to be triggered
    TriggerDetails
    After InsertAfter a single record is inserted
    After UpdateAfter a single record is updated
    After DeleteAfter a single record is deleted
    After Bulk InsertAfter bulk records are inserted
    After Bulk UpdateAfter bulk records are updated
    After Bulk DeleteAfter bulk records are deleted
    1. Method & URL: Configure the endpoint to which webhook needs to be triggered. Supported methods are GET, POST, DELETE, PUT, HEAD, PATCH
    2. Headers & Parameters: Configure Request headers & parameters (optional)
    3. Condition: Only records meeting the configured criteria will trigger webhook (optional)
    4. Test webhook (with sample payload) to verify if parameter are configured appropriately (optional)
    5. Save the webhook

    Configuring webhook

    Webhook Response Sample​

    {
      "type": "records.after.insert",
      "id": "9dac1c54-b3be-49a1-a676-af388145fa8c",
      "data": {
        "table_id": "md_xzru7dcqrecc60",
        "table_name": "Film",
        "view_id": "vw_736wrpoas7tr0c",
        "view_name": "Film",
        "records": [
          {
            "FilmId": 1011,
            "Title": "FOO",
            "Language": {
              "LanguageId": 1,
              "Name": "English"
            },
          }
        ]
      }
    }
    - +
    Version: Latest

    Create webhook

    Create Webhook​

    Accessing webhook page​

    1. Click on table for which webhook needs to be configured on the left sidebar
    2. Open Details tab in topbar,
    3. Click on Webhooks tab
    4. Click Add New Webhook

    Accessing webhook

    Configuring webhook​

    1. Name of the webhook
    2. Select the event for which webhook needs to be triggered
    TriggerDetails
    After InsertAfter a single record is inserted
    After UpdateAfter a single record is updated
    After DeleteAfter a single record is deleted
    After Bulk InsertAfter bulk records are inserted
    After Bulk UpdateAfter bulk records are updated
    After Bulk DeleteAfter bulk records are deleted
    1. Method & URL: Configure the endpoint to which webhook needs to be triggered. Supported methods are GET, POST, DELETE, PUT, HEAD, PATCH
    2. Headers & Parameters: Configure Request headers & parameters (optional)
    3. Condition: Only records meeting the configured criteria will trigger webhook (optional)
    4. Test webhook (with sample payload) to verify if parameter are configured appropriately (optional)
    5. Save the webhook

    Configuring webhook

    Webhook Response Sample​

    {
      "type": "records.after.insert",
      "id": "9dac1c54-b3be-49a1-a676-af388145fa8c",
      "data": {
        "table_id": "md_xzru7dcqrecc60",
        "table_name": "Film",
        "view_id": "vw_736wrpoas7tr0c",
        "view_name": "Film",
        "records": [
          {
            "FilmId": 1011,
            "Title": "FOO",
            "Language": {
              "LanguageId": 1,
              "Name": "English"
            },
          }
        ]
      }
    }
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/automation/webhook/webhook-overview/index.html b/packages/noco-docs/dist/automation/webhook/webhook-overview/index.html index 176992b1c8..f3b5e546ad 100644 --- a/packages/noco-docs/dist/automation/webhook/webhook-overview/index.html +++ b/packages/noco-docs/dist/automation/webhook/webhook-overview/index.html @@ -4,13 +4,13 @@ Webhook overview | NocoDB - +
    -
    Version: Latest

    Webhook overview

    You can employ webhooks to notify external systems whenever there are additions, updates, or removals of records within NocoDB. This feature allows you to receive instantaneous notifications for any changes made to your database. NocoDB also offers webhooks for bulk endpoints for creating, updating, or deleting multiple records simultaneously.

    Note that, Webhooks currently are specific to associated table.

    - +
    Version: Latest

    Webhook overview

    You can employ webhooks to notify external systems whenever there are additions, updates, or removals of records within NocoDB. This feature allows you to receive instantaneous notifications for any changes made to your database. NocoDB also offers webhooks for bulk endpoints for creating, updating, or deleting multiple records simultaneously.

    Note that, Webhooks currently are specific to associated table.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/bases/actions-on-base/index.html b/packages/noco-docs/dist/bases/actions-on-base/index.html index 3b37cb55ff..73c3dfa18c 100644 --- a/packages/noco-docs/dist/bases/actions-on-base/index.html +++ b/packages/noco-docs/dist/bases/actions-on-base/index.html @@ -4,16 +4,16 @@ Actions on base | NocoDB - +
    -
    Version: Latest

    Actions on base

    Base context menu​

    The base context menu offers a selection of swift actions that can be executed on a base. To access this menu, click on the ellipsis symbol (...) located adjacent to the base name within the left sidebar. +

    Version: Latest

    Actions on base

    Base context menu​

    The base context menu offers a selection of swift actions that can be executed on a base. To access this menu, click on the ellipsis symbol (...) located adjacent to the base name within the left sidebar. base context menu

    Rename base​

    To modify the name of a base, you can easily do so by following these steps:

    1. Initiate the base context menu by clicking on the ellipses ... located next to the base name within the left sidebar.
    2. In the dropdown menu that appears, choose the Rename option.
    3. Input the new name for the base directly within the field provided and then press the Enter key to confirm and save the updated name.

    base context menu

    base rename

    Star base​

    You can star a base by following simple steps below:

    1. Initiate the base context menu by clicking on the ellipses ... located next to the base name within the left sidebar.
    2. In the dropdown menu that appears, choose the Add to Starred option.
    3. Subsequently, the designated base will be placed into the "Starred" section, conveniently positioned within the left sidebar.

    base context menu

    base starred

    info

    Starred base will appear in both Starred section and All Bases section on the left sidebar.

    Remove a base from starred list​

    1. Initiate the base context menu by clicking on the ellipses ... located next to the base name within the left sidebar.
    2. In the dropdown menu that appears, choose the Remove from Starred option.
    3. Subsequently, the designated base will be removed from the Starred section.

    image

    Duplicate base​

    To duplicate a base, you can follow these straightforward steps:

    1. Initiate the base context menu by clicking on the ellipses ... located next to the base name within the left sidebar.
    2. In the dropdown menu that appears, choose the Duplicate option.
    3. Optionally, you can configure the duplication process with the following choices: a) Include data: You have the flexibility to choose whether to duplicate the base with or without its data. b) Include views: You can decide whether to duplicate the base with or without its views.
    4. Click the Confirm button in the confirmation modal that pops up.
    5. A new base will be created, mirroring the original base's schema and data/views based on the configurations specified in step 3.

    base context menu

    image

    info
    • A duplicate base will be generated within the same workspace as the original base.
    • The duplicated base will be suffixed with Copy in its name.
    • You will be designated as the base owner upon the duplication of the base.
    • Existing base members will not be transferred to the duplicated base.

    Delete base​

    If you determine that a base is no longer necessary, you have the option to permanently remove it from your workspace. Deleting a base will delete all the tables and data associated with it.

    danger

    This action cannot be undone.

    info

    Only base owner can delete a workspace.

    To delete a base:

    1. Initiate the base context menu by clicking on the ellipses ... located next to the base name within the left sidebar.
    2. In the dropdown menu that appears, choose the Delete option.
    3. Select Delete base button on the confirmation dialog box.

    base context menu

    base delete

    Developer features​

    Base settings​

    Some general configurations are available for you to modify within the base settings.

    1. Show M2M tables: Toggle this option to display/hide M2M tables within the left sidebar. Many-to-many relation is supported via a junction table & is hidden by default.
    2. Show NULL in cells: Toggle this option to display/hide NULL values within the cells of the table. This helps differentiate against cells holding EMPTY string.
    3. Show NULL & Empty in Filters: Enable 'additional' filters to differentiate fields containing NULL & Empty Strings. Default support for Blank treats both NULL & Empty strings alike.

    To configure base settings, you can follow these steps:

    1. Initiate the base context menu by clicking on the ellipses ... located next to the base name within the left sidebar.
    2. In the dropdown menu that appears, choose the Settings option.

    base context menu

    bsae settings

    REST APIs​

    NocoDB provides a Swagger UI for each base. To access the Swagger UI, follow these steps:

    1. Initiate the base context menu by clicking on the ellipses ... located next to the base name within the left sidebar.
    2. In the dropdown menu that appears, choose the REST APIs option.

    base context menu

    swagger

    Relations​

    NocoDB provides a visual representation of the relations between tables within a base. To access the relations diagram, follow these steps:

    1. Initiate the base context menu by clicking on the ellipses ... located next to the base name within the left sidebar.
    2. In the dropdown menu that appears, choose the Relations option.

    base context menu

    base relations

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/bases/base-collaboration/index.html b/packages/noco-docs/dist/bases/base-collaboration/index.html index 39e7ea80d0..bcf020c8c3 100644 --- a/packages/noco-docs/dist/bases/base-collaboration/index.html +++ b/packages/noco-docs/dist/bases/base-collaboration/index.html @@ -4,13 +4,13 @@ Base collaboration | NocoDB - +
    -
    Version: Latest

    Base collaboration

    A member added to a workspace will carry his assigned role specific permissions to all the base with in workspace. To override member permissions to your base, please follow steps outlined below:

    1. Go to the left sidebar and select Base name to access the Base Dashboard.
    2. Click on the Members tab.
    3. Use the dropdown menu to specify the access permissions for the member you wish to collaborate.
    4. Finalize the process by assigning the desired role to the user.

    image

    More details about roles & permissions can be found here.

    - +
    Version: Latest

    Base collaboration

    A member added to a workspace will carry his assigned role specific permissions to all the base with in workspace. To override member permissions to your base, please follow steps outlined below:

    1. Go to the left sidebar and select Base name to access the Base Dashboard.
    2. Click on the Members tab.
    3. Use the dropdown menu to specify the access permissions for the member you wish to collaborate.
    4. Finalize the process by assigning the desired role to the user.

    image

    More details about roles & permissions can be found here.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/bases/base-overview/index.html b/packages/noco-docs/dist/bases/base-overview/index.html index ba7cbbc586..0b5a79f69b 100644 --- a/packages/noco-docs/dist/bases/base-overview/index.html +++ b/packages/noco-docs/dist/bases/base-overview/index.html @@ -4,12 +4,12 @@ Base overview | NocoDB - +
    -
    Version: Latest

    Base overview

    In NocoDB, bases are the foundational elements that encompass tables, views, forms, and webhooks, providing a structured framework for data organization and collaborative work. It's essential to understand that each base is inherently tied to a specific workspace and cannot be transferred between different workspaces. The creator of a base is designated as the 'base owner,' and this ownership status is non-transferable, conferring exclusive authority over the base, including the ability to delete it.

    Bases also come with their unique set of members and access permissions, which take precedence over any permissions set at the workspace level. This fine-grained control allows for tailored collaboration and data management within each base. Importantly, there are no restrictions on the number of members you can invite to a base, fostering open teamwork. Similarly, you have the freedom to create as many tables as needed within a single base, +

    Version: Latest

    Base overview

    In NocoDB, bases are the foundational elements that encompass tables, views, forms, and webhooks, providing a structured framework for data organization and collaborative work. It's essential to understand that each base is inherently tied to a specific workspace and cannot be transferred between different workspaces. The creator of a base is designated as the 'base owner,' and this ownership status is non-transferable, conferring exclusive authority over the base, including the ability to delete it.

    Bases also come with their unique set of members and access permissions, which take precedence over any permissions set at the workspace level. This fine-grained control allows for tailored collaboration and data management within each base. Importantly, there are no restrictions on the number of members you can invite to a base, fostering open teamwork. Similarly, you have the freedom to create as many tables as needed within a single base, offering the scalability required to accommodate diverse datasets and projects.

    To get started, you can create an empty base if you want to start from scratch. If you've already been using Airtable, we make it easy to import your base. When collaborating with your team, you can invite them to work on a base together. If you want to share your data with a broader audience, you can make your base public. If you ever need to rename your base, you can do so by using the rename base feature. And, if you find a base especially useful, you can bookmark it for quick access. However, when the time comes to remove a base, you can delete it.

    Base Dashboard​

    The Base Dashboard serves as the primary landing page for a base, offering users a concise summary of its contents and functionality. This central hub provides users with swift access to essential features such as base settings and collaboration tools. To access the Base Dashboard, simply click on the base name located in the left sidebar.

    image

    The Base Dashboard is organized into three key sections, each serving a distinct purpose:

    1. Table List: This section provides a comprehensive list of all tables within the base, @@ -23,7 +23,7 @@ integrate them as native tables. This section provides a listing of connected da for additional details on this feature, which will be covered in the forthcoming Data Sources section. This feature empowers users to work with external data as effortlessly as with in-house data tables, enhancing the versatility and scope of data management within the base.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/bases/create-base/index.html b/packages/noco-docs/dist/bases/create-base/index.html index 6cb9b5dd07..3e3cf9d347 100644 --- a/packages/noco-docs/dist/bases/create-base/index.html +++ b/packages/noco-docs/dist/bases/create-base/index.html @@ -4,14 +4,14 @@ Create base | NocoDB - +
    -
    Version: Latest

    Create base

    Create base from scratch​

    To initiate the creation of a new database from the ground up, follow these steps:

    1. Navigate to the left sidebar and either select the + icon adjacent to Projects or click on the + New Project button.
    2. Input the desired name for the database within the presented pop-up modal.
    3. Conclude the process by clicking on the Create Database button.

    image +

    Version: Latest

    Create base

    Create base from scratch​

    To initiate the creation of a new database from the ground up, follow these steps:

    1. Navigate to the left sidebar and either select the + icon adjacent to Projects or click on the + New Project button.
    2. Input the desired name for the database within the presented pop-up modal.
    3. Conclude the process by clicking on the Create Database button.

    image image

    info
    • Upon the creation of the base, you will assume the role of the base owner.
    • Only the base owner possesses the authority to delete a base.
    • It is possible to create multiple bases within a single workspace.

    On the successful creation of a base, you will be directed to the Base Dashboard, which serves as the primary landing page for the base. This central hub provides users with swift access to essential features such as base settings and collaboration tools. To access the Base Dashboard, simply click on the base name located in the left sidebar.

    Find more details on adding tables to a base in the Tables section.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/bases/import-base-from-airtable/index.html b/packages/noco-docs/dist/bases/import-base-from-airtable/index.html index 852b8ce2da..04f39816fb 100644 --- a/packages/noco-docs/dist/bases/import-base-from-airtable/index.html +++ b/packages/noco-docs/dist/bases/import-base-from-airtable/index.html @@ -4,14 +4,14 @@ Import Airtable to NocoDB | NocoDB - +
    -
    Version: Latest

    Import Airtable to NocoDB

    NocoDB offers a streamlined process for seamlessly transferring your Airtable database to various database management systems, including MySQL, Postgres and SQLite, in just a matter of minutes. This feature is particularly useful for users who wish to migrate their Airtable database to a more robust and scalable database management system.

    info

    Import from Airtable is in beta version. See Importing Airtable To NocoDB for the migration notes.

    info

    To proceed, you must have valid Airtable Credentials. Ensure you have access to the following information from your Airtable account:

    Open the Quick Import- AIRTABLE modal begin the import process

    1. Hover over the base name in the left sidebar, click on the ... icon to open base context menu
    2. Select Import Data from the base context menu
    3. Select Airtable

    import data

    Alternatively, you can also open the Quick Import- AIRTABLE modal from the Base dashboard

    1. Go to your Base dashboard, click on Import Data

    2. Select Airtable

      import data

      import data

    Continue with the following steps on Quick Import- AIRTABLE modal to complete the import process:

    1. Input API key / Personal Access Token
    2. Input shared Base ID / URL
    3. Configure Airtable import options (Optional)
    4. Click Import

    import data

    info

    Wait until Go To Dashboard button is activated on the modal. Import details are captured in log window.

    import data

    Configuration options​

    1. Import Data: If you disable this option, only tables and views will be created (schema), excluding actual data records.
    2. Import Secondary Views: If you disable this option, only the primary grid view for each table will be imported, omitting any secondary views.
    3. Import Rollup Fields: If you disable this option, you can skip the import of Rollup fields.
    4. Import Lookup Fields: If you disable this option, you can skip the import of Lookup fields.
    5. Import Attachments Fields: If you disable this option, you can skip the import of Attachment fields, which typically store file attachments associated with records.
    6. Import Formula Fields: Please be aware that import of formula fields from Airtable is currently not supported.

    Get Airtable Credentials​

    Create Personal Access Token​

    Here are the steps to generate an Airtable Personal Access Token:

    1. Visit the Airtable Create Tokens page and click the "Create token" button.
    2. Provide a meaningful name for your token in the Token name field.
    3. Choose the necessary access scopes, with a minimum requirement of data.records:read.
    4. Select the specific Base you wish to access with this token.
    5. Confirm your choices by clicking the Create token button.
    6. Copy the newly generated Personal Access Token for your use.

    For detailed information, you can refer to the Airtable Personal Access Token guide.

    image

    image

    image

    Retrieve API Key​

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/bases/share-base/index.html b/packages/noco-docs/dist/bases/share-base/index.html index 1cd710f95d..065a632a0a 100644 --- a/packages/noco-docs/dist/bases/share-base/index.html +++ b/packages/noco-docs/dist/bases/share-base/index.html @@ -4,16 +4,16 @@ Share base | NocoDB - +
    -
    Version: Latest

    Share base

    To share a base, follow the steps below:

    1. Navigate to the top right corner of the top navigation bar and click on the Share button.
    2. In the Shared base section, toggle the switch to Enable public access in order to activate the shared base feature.
    3. The generated link for the shared base will be displayed above and can be utilized to share this project with others. To copy the URL, simply click on the Copy Link option.

    Share base

    Share base

    Modify Share base​

    Amending the Share base setting will render the previously generated Share base link invalid and generate a new link in its place. +

    Version: Latest

    Share base

    To share a base, follow the steps below:

    1. Navigate to the top right corner of the top navigation bar and click on the Share button.
    2. In the Shared base section, toggle the switch to Enable public access in order to activate the shared base feature.
    3. The generated link for the shared base will be displayed above and can be utilized to share this project with others. To copy the URL, simply click on the Copy Link option.

    Share base

    Share base

    Modify Share base​

    Amending the Share base setting will render the previously generated Share base link invalid and generate a new link in its place. Here are the steps to modify it:

    1. Click on the Share button located in the top right corner of the toolbar.
    2. Toggle the option labeled Enable public access to deactivate the base share.
    3. Toggle the same option, Enable public access, to reactivate the base share, subsequently generating a new link.

    Enable public access

    Disable Share base​

    Disabling Share base will render the previously generated Share base link invalid Here are the steps to disable it:

    1. Click on the 'Share' button located in the top right corner of the toolbar.
    2. Toggle the option labeled Enable public access to deactivate the base share.

    Enable public access

    Share base Access Permissions​

    The "Shared base" can be configured in two modes:

    1. Viewer - Users with the provided link will have read-only access to the base data.
    2. Editor - Users with the provided link will have read and write access to the base data.

    Toggle Enable Editor Access button to configure permissions as desired Share base edit access

    Embeddable Frame​

    The NocoDB interface can be seamlessly integrated into existing applications through the utilization of the HTML IFRAME attribute. This feature empowers users to embed the NocoDB interface into their applications, allowing for a unified user experience. To generate the embeddable HTML code, follow these steps:

    To Generate Embeddable HTML Code:

    1. Click the Share button located in the top right corner of the toolbar.
    2. Within the Shared base link tab, select the button to copy the Embeddable HTML code to your clipboard.

    Share base iFrame

    Example:

    <iframe
        class="nc-embed"
        src="https://nocodb-nocodb-rsyir.ondigitalocean.app/dashboard/#/nc/base/e3bba9df-4fc1-4d11-b7ce-41c4a3ad6810?embed"
        frameBorder="0"
        width="100%"
        height="700"
        style="background: transparent; border: 1px solid #ddd"
    >
    </iframe>

    Embed into application's HTML Body​

    Sample code with embedded iframe generated above

    <!DOCTYPE html>
    <html>
        <body>
            <iframe
                class="nc-embed"
                src="http://localhost:3000/#/nc/base/7d4b551c-b5e0-41c9-a87b-f3984c21d2c7?embed"
                frameBorder="0"
                width="100%"
                height="700"
                style="background: transparent; "
            ></iframe>
        </body>
    </html>
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/collaboration/base-collaboration/index.html b/packages/noco-docs/dist/collaboration/base-collaboration/index.html index 9f27fb2935..85bb9b9897 100644 --- a/packages/noco-docs/dist/collaboration/base-collaboration/index.html +++ b/packages/noco-docs/dist/collaboration/base-collaboration/index.html @@ -4,13 +4,13 @@ Base collaboration | NocoDB - +
    -
    Version: Latest

    Base collaboration

    Inviting members to your base​

    A member added to a workspace will carry his assigned role specific permissions to all the base with in workspace. To override member permissions to your base, please follow steps outlined below:

    1. Go to the left sidebar and select Base name to access the Base Dashboard.
    2. Click on the Members tab.
    3. Use the dropdown menu to specify the access permissions for the member you wish to collaborate.
    4. Finalize the process by assigning the desired role to the user.

    image

    More details about roles & permissions can be found here.

    Removing members from your base​

    1. Go to the left sidebar and select Base name to access the Base Dashboard.
    2. Click on the Members tab.
    3. Use the dropdown menu to specify the access permissions for the member you wish to collaborate.
    4. Assign the No Access role to the user.

    image

    - +
    Version: Latest

    Base collaboration

    Inviting members to your base​

    A member added to a workspace will carry his assigned role specific permissions to all the base with in workspace. To override member permissions to your base, please follow steps outlined below:

    1. Go to the left sidebar and select Base name to access the Base Dashboard.
    2. Click on the Members tab.
    3. Use the dropdown menu to specify the access permissions for the member you wish to collaborate.
    4. Finalize the process by assigning the desired role to the user.

    image

    More details about roles & permissions can be found here.

    Removing members from your base​

    1. Go to the left sidebar and select Base name to access the Base Dashboard.
    2. Click on the Members tab.
    3. Use the dropdown menu to specify the access permissions for the member you wish to collaborate.
    4. Assign the No Access role to the user.

    image

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/collaboration/collaboration-overview/index.html b/packages/noco-docs/dist/collaboration/collaboration-overview/index.html index 84ab834701..e475b81b6a 100644 --- a/packages/noco-docs/dist/collaboration/collaboration-overview/index.html +++ b/packages/noco-docs/dist/collaboration/collaboration-overview/index.html @@ -4,16 +4,16 @@ Collaboration overview | NocoDB - +
    -
    Version: Latest

    Collaboration overview

    At NocoDB, our passion lies in promoting teamwork, and it's a significant factor contributing to our popularity. Through NocoDB's collaborative functionalities, you have the ability to foster effective task distribution and team communication by extending invitations to others for seamless cooperation.

    In this segment, we'll discuss various collaboration features that NocoDB offers.

    Workspace collaboration
    +

    Version: Latest

    Collaboration overview

    At NocoDB, our passion lies in promoting teamwork, and it's a significant factor contributing to our popularity. Through NocoDB's collaborative functionalities, you have the ability to foster effective task distribution and team communication by extending invitations to others for seamless cooperation.

    In this segment, we'll discuss various collaboration features that NocoDB offers.

    Workspace collaboration
    Base collaboration
    Share base
    Share view

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/collaboration/oss-specific-details/index.html b/packages/noco-docs/dist/collaboration/oss-specific-details/index.html index b0eef95b35..5a07574bfd 100644 --- a/packages/noco-docs/dist/collaboration/oss-specific-details/index.html +++ b/packages/noco-docs/dist/collaboration/oss-specific-details/index.html @@ -4,13 +4,13 @@ In Open Source | NocoDB - +
    -
    Version: Latest

    In Open Source

    Open source NocoDB includes a default workspace, and it does not allow the creation of additional workspaces. And hence, the user management on Open source is different from Cloud hosted solutions. This article details the specifics of User management on Open source.

    User Management​

    Organisation is an workspace equivalent concept in Open-source NocoDB. An organisation can have multiple bases. Permissions within NocoDB are divided into two levels: Organisation level and Base level.

    Organisation Level Permissions:​

    • Org Level Creator: Allows users to create new bases and access invited bases.
    • Org Level Viewer: Allows users to access invited bases but does not permit the creation of new bases.

    Screenshot 2023-08-22 at 5 01 41 PM

    Screenshot 2023-08-22 at 5 01 30 PM

    Base Level Permissions:​

    The permissions at base level in Open source NocoDB remain same as cloud solutions. The base level permissions are summarized below:

    • Owner: The user who created the project. A project can have only one owner. The owner persists until the project exists and the role is non-transferable. The owner has access to carry out any operations within the project, including deleting it.
    • Creator: Has access to carry out any operations within the project except deleting the project and removing the "Owner."
    • Editor: Can modify data but cannot modify the schema (add/remove fields, tables, users, and such).
    • Commenter: Can neither modify data nor schema, can only see data and can mark record-level comments.
    • Viewer: Can only see data.

    Please note that the above-mentioned Base Level Permissions are additional to the already defined Organisation Level Permissions.

    In addition to the previously defined permissions, NocoDB also includes the role of Super Admin. The Super Admin is the first user to sign up on this NocoDB installation. An organisation can have only one Super Admin and this role is non-transferable. The Super Admin will have the equivalent permissions of an "Org Level Creator" and "Owner" for all projects within the organisation.

    - +
    Version: Latest

    In Open Source

    Open source NocoDB includes a default workspace, and it does not allow the creation of additional workspaces. And hence, the user management on Open source is different from Cloud hosted solutions. This article details the specifics of User management on Open source.

    User Management​

    Organisation is an workspace equivalent concept in Open-source NocoDB. An organisation can have multiple bases. Permissions within NocoDB are divided into two levels: Organisation level and Base level.

    Organisation Level Permissions:​

    • Org Level Creator: Allows users to create new bases and access invited bases.
    • Org Level Viewer: Allows users to access invited bases but does not permit the creation of new bases.

    Screenshot 2023-08-22 at 5 01 41 PM

    Screenshot 2023-08-22 at 5 01 30 PM

    Base Level Permissions:​

    The permissions at base level in Open source NocoDB remain same as cloud solutions. The base level permissions are summarized below:

    • Owner: The user who created the project. A project can have only one owner. The owner persists until the project exists and the role is non-transferable. The owner has access to carry out any operations within the project, including deleting it.
    • Creator: Has access to carry out any operations within the project except deleting the project and removing the "Owner."
    • Editor: Can modify data but cannot modify the schema (add/remove fields, tables, users, and such).
    • Commenter: Can neither modify data nor schema, can only see data and can mark record-level comments.
    • Viewer: Can only see data.

    Please note that the above-mentioned Base Level Permissions are additional to the already defined Organisation Level Permissions.

    In addition to the previously defined permissions, NocoDB also includes the role of Super Admin. The Super Admin is the first user to sign up on this NocoDB installation. An organisation can have only one Super Admin and this role is non-transferable. The Super Admin will have the equivalent permissions of an "Org Level Creator" and "Owner" for all projects within the organisation.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/collaboration/share-base/index.html b/packages/noco-docs/dist/collaboration/share-base/index.html index a1f10a8382..e89f85c5d9 100644 --- a/packages/noco-docs/dist/collaboration/share-base/index.html +++ b/packages/noco-docs/dist/collaboration/share-base/index.html @@ -4,16 +4,16 @@ Share base | NocoDB - +
    -
    Version: Latest

    Share base

    To share a base, follow the steps below:

    1. Navigate to the top right corner of the top navigation bar and click on the Share button.
    2. In the Shared base section, toggle the switch to Enable public access in order to activate the shared base feature.
    3. The generated link for the shared base will be displayed above and can be utilized to share this project with others. To copy the URL, simply click on the Copy Link option.

    Share base

    Share base

    Modify Share base​

    Amending the Share base setting will render the previously generated Share base link invalid and generate a new link in its place. +

    Version: Latest

    Share base

    To share a base, follow the steps below:

    1. Navigate to the top right corner of the top navigation bar and click on the Share button.
    2. In the Shared base section, toggle the switch to Enable public access in order to activate the shared base feature.
    3. The generated link for the shared base will be displayed above and can be utilized to share this project with others. To copy the URL, simply click on the Copy Link option.

    Share base

    Share base

    Modify Share base​

    Amending the Share base setting will render the previously generated Share base link invalid and generate a new link in its place. Here are the steps to modify it:

    1. Click on the Share button located in the top right corner of the toolbar.
    2. Toggle the option labeled Enable public access to deactivate the base share.
    3. Toggle the same option, Enable public access, to reactivate the base share, subsequently generating a new link.

    Enable public access

    Disable Share base​

    Disabling Share base will render the previously generated Share base link invalid Here are the steps to disable it:

    1. Click on the 'Share' button located in the top right corner of the toolbar.
    2. Toggle the option labeled Enable public access to deactivate the base share.

    Enable public access

    Share base Access Permissions​

    The "Shared base" can be configured in two modes:

    1. Viewer - Users with the provided link will have read-only access to the base data.
    2. Editor - Users with the provided link will have read and write access to the base data.
    note
    • The default access permission is set to Viewer
    • Shared base with Editor access permission is only available in Self-hosted version currently

    Toggle Enable Editor Access button to configure permissions as desired Share base edit access

    Embeddable Frame​

    The NocoDB interface can be seamlessly integrated into existing applications through the utilization of the HTML IFRAME attribute. This feature empowers users to embed the NocoDB interface into their applications, allowing for a unified user experience. To generate the embeddable HTML code, follow these steps:

    To Generate Embeddable HTML Code:

    1. Click the Share button located in the top right corner of the toolbar.
    2. Within the Shared base link tab, select the button to copy the Embeddable HTML code to your clipboard.

    Share base iFrame

    Example:

    <iframe
            class="nc-embed"
            src="https://nocodb-nocodb-rsyir.ondigitalocean.app/dashboard/#/nc/base/e3bba9df-4fc1-4d11-b7ce-41c4a3ad6810?embed"
            frameBorder="0"
            width="100%"
            height="700"
            style="background: transparent; border: 1px solid #ddd"
    >
    </iframe>

    Embed into application's HTML Body​

    Sample code with embedded iframe generated above

    <!DOCTYPE html>
    <html>
    <body>
    <iframe
            class="nc-embed"
            src="http://localhost:3000/#/nc/base/7d4b551c-b5e0-41c9-a87b-f3984c21d2c7?embed"
            frameBorder="0"
            width="100%"
            height="700"
            style="background: transparent; "
    ></iframe>
    </body>
    </html>
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/collaboration/share-view/index.html b/packages/noco-docs/dist/collaboration/share-view/index.html index 5ffca215fe..fc6fb68647 100644 --- a/packages/noco-docs/dist/collaboration/share-view/index.html +++ b/packages/noco-docs/dist/collaboration/share-view/index.html @@ -4,16 +4,16 @@ Share view | NocoDB - +
    -
    Version: Latest

    Share view

    Generate Share View​

    1. Click Share button on the top right of the toolbar
    2. Toggle Enable public viewing to create shared view link
    3. Click Copy button to copy the link to clipboard

    share button

    shared view

    Share view options​

    Password protection​

    You can enable Restrict access with a password if you want a password-protected view

    password protection

    Download options​

    You can toggle Allow Download button to enable or disable download CSV/XLSX options in the shared view link

    download options

    Share Form View Options​

    Form view has additional customizations for shared view. You can enable/disable the following options for shared form view:

    1. Survey mode: This option when enabled, will display the form in survey mode.
    2. RTL Orientation: This option when enabled, will display the form in RTL orientation.
    3. Themes: You can select a theme for the form from the dropdown. +
      Version: Latest

      Share view

      Generate Share View​

      1. Click Share button on the top right of the toolbar
      2. Toggle Enable public viewing to create shared view link
      3. Click Copy button to copy the link to clipboard

      share button

      shared view

      Share view options​

      Password protection​

      You can enable Restrict access with a password if you want a password-protected view

      password protection

      Download options​

      You can toggle Allow Download button to enable or disable download CSV/XLSX options in the shared view link

      download options

      Share Form View Options​

      Form view has additional customizations for shared view. You can enable/disable the following options for shared form view:

      1. Survey mode: This option when enabled, will display the form in survey mode.
      2. RTL Orientation: This option when enabled, will display the form in RTL orientation.
      3. Themes: You can select a theme for the form from the dropdown. form view options

      Access Share View​

      To access the shared view, please follow the steps below: Click on the Shared View URL. If the URL is password-protected, you will be prompted to enter the password to unlock it. Please input the required password to proceed.

      password modal

      Once the password is successfully entered and authenticated, you will gain access to the shared view. In the event that the URL is not password-protected, you will be directed to the shared view directly, without the need for a password.

      share-view

      Users with the shared view link can only view the data and cannot make any changes to the view or its content. Records and fields in the shared view will be updated in real-time as changes are made to the original view. Users accessing shared view can apply filters and sort records as per their requirements.

      info

      Note that, filters & sorts applied to shared view will not be persisted. These filters & sorts will be reset when the shared view is accessed again.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/collaboration/workspace-collaboration/index.html b/packages/noco-docs/dist/collaboration/workspace-collaboration/index.html index f0c75e7ccc..a748e56ccf 100644 --- a/packages/noco-docs/dist/collaboration/workspace-collaboration/index.html +++ b/packages/noco-docs/dist/collaboration/workspace-collaboration/index.html @@ -4,16 +4,16 @@ Workspace collaboration | NocoDB - +
    -
    Version: Latest

    Workspace collaboration

    note

    A comprehensive guide regarding roles and permissions can be accessed here.

    Invite members to Workspace​

    1. Navigate to the Workspace configuration page by selecting Team & Settings in the left sidebar.
    2. Access the Members tab.
    3. Input the email address of the intended member for the invitation.
    4. Click on Role dropdown menu
    5. Choose the appropriate access permission for the member from the dropdown menu.
    6. Conclude the process by selecting the Add Member(s) button.

    image

    info

    You have the capability to invite multiple members simultaneously by entering their email addresses, separated by commas.

    List Workspace members​

    The Members tab displays a list of users who have been granted access to the workspace. +

    Version: Latest

    Workspace collaboration

    note

    A comprehensive guide regarding roles and permissions can be accessed here.

    Invite members to Workspace​

    1. Navigate to the Workspace configuration page by selecting Team & Settings in the left sidebar.
    2. Access the Members tab.
    3. Input the email address of the intended member for the invitation.
    4. Click on Role dropdown menu
    5. Choose the appropriate access permission for the member from the dropdown menu.
    6. Conclude the process by selecting the Add Member(s) button.

    image

    info

    You have the capability to invite multiple members simultaneously by entering their email addresses, separated by commas.

    List Workspace members​

    The Members tab displays a list of users who have been granted access to the workspace. image

    Modify Workspace Member Roles​

    You can modify the access permissions of members by following these steps:

    1. Access the dropdown menu.
    2. Select the desired new role option. image

    Remove Workspace Members​

    To remove a member from the workspace, take the following steps:

    1. Click on the vertical ellipses ⋮ to open the context menu.
    2. Select the Remove User option. image
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/data-sources/actions-on-data-sources/index.html b/packages/noco-docs/dist/data-sources/actions-on-data-sources/index.html index bc42899015..1cac29bb32 100644 --- a/packages/noco-docs/dist/data-sources/actions-on-data-sources/index.html +++ b/packages/noco-docs/dist/data-sources/actions-on-data-sources/index.html @@ -4,14 +4,14 @@ Actions on Data sources | NocoDB - +
    -
    Version: Latest

    Actions on Data sources

    Edit external database configuration parameters​

    1. Access Base context menu by clicking on the Base name in the left sidebar
    2. Click on Data Sources tab
    3. Click on Edit icon listed under Actions column for the data source that you wish to access ERD (Relations view) for +
      Version: Latest

      Actions on Data sources

      Edit external database configuration parameters​

      1. Access Base context menu by clicking on the Base name in the left sidebar
      2. Click on Data Sources tab
      3. Click on Edit icon listed under Actions column for the data source that you wish to access ERD (Relations view) for Go to Data Sources, click Edit icon, you can re-configure database credentials.
        Please make sure database configuration parameters are valid. Any incorrect parameters could lead to schema loss!

      relations

      edit db config

      Remove data source​

      1. Access Base context menu by clicking on the Base name in the left sidebar
      2. Click on Data Sources tab
      3. Click on Delete icon listed under Actions column for the data source that you wish to Unlink

      datasource unlink

      note

      Unlinking a data source will not delete the external data source. It will only remove the data source from the current project.

      Data source visibility​

      1. Access Base context menu by clicking on the Base name in the left sidebar
      2. Click on Data Sources tab
      3. Toggle radio button listed under Visibility column for the data source that you wish to hide/un-hide

      datasource visibility

      UI Access Control​

      info

      UI Access Control is available only in Open Source version of NocoDB.

      1. Access Base context menu by clicking on the Base name in the left sidebar
      2. Click on Data Sources tab
      3. Click on UI ACL button listed under Actions column for the data source that you wish to manage UI access control for
      4. On the UI ACL modal, you can see the list of tables available in the data source as rows & roles available as columns. Toggle checkboxes to enable/disable access to tables for specific roles.
      5. Click on Save button to save the changes

      ui acl

      ui acl

      Audit logs​

      1. Access Base context menu by clicking on the Base name in the left sidebar
      2. Click on Data Sources tab
      3. Click on Audit button listed under Actions column for the data source that you wish to access Audit logs for

      audit

      audit logs

      Relations​

      1. Access Base context menu by clicking on the Base name in the left sidebar
      2. Click on Data Sources tab
      3. Click on Relations button listed under Actions column for the data source that you wish to access ERD (Relations view) for

      relations

      relations

      Junction table names within Relations​

      • Enable Show M2M Tables within Project Settings menu
      • Double-click on Show Fields to see additional checkboxes get enabled.
        • Enabling which you should be able to see junction tables and their table names.

      image

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/data-sources/connect-to-data-source/index.html b/packages/noco-docs/dist/data-sources/connect-to-data-source/index.html index 628c80aca2..5e2b6d7c4c 100644 --- a/packages/noco-docs/dist/data-sources/connect-to-data-source/index.html +++ b/packages/noco-docs/dist/data-sources/connect-to-data-source/index.html @@ -4,13 +4,13 @@ Connect to a Data source | NocoDB - +
    -
    Version: Latest

    Connect to a Data source

    To connect to an external data source, follow the steps below:

    1. Access Base context menu by clicking on the Base name in the left sidebar

    2. Select Data Sources tab

    3. Click on + New Data Source button

    4. On the pop-up modal, provide the following details:

      Field NameDescription
      Source NameName for this data source for display on NocoDB UI
      Database TypeType of the data source. Currently, NocoDB supports PostgreSQL & MySQL data sources.
      Host AddressHostname of the data source
      Port NumberPort number of the data source
      UsernameUsername to connect to the database
      PasswordPassword to connect to the database
      DatabaseName of the database to connect to
      Schema nameName of the schema to connect to

    5. Click on Test Database Connection button to verify the connection

    6. Wait for the connection to be verified.

    • After connection is successful, Submit button will be enabled.
    • Click on Submit button to save the data source.

    data source-1

    data source-2

    data source-3

    - +
    Version: Latest

    Connect to a Data source

    To connect to an external data source, follow the steps below:

    1. Access Base context menu by clicking on the Base name in the left sidebar

    2. Select Data Sources tab

    3. Click on + New Data Source button

    4. On the pop-up modal, provide the following details:

      Field NameDescription
      Source NameName for this data source for display on NocoDB UI
      Database TypeType of the data source. Currently, NocoDB supports PostgreSQL & MySQL data sources.
      Host AddressHostname of the data source
      Port NumberPort number of the data source
      UsernameUsername to connect to the database
      PasswordPassword to connect to the database
      DatabaseName of the database to connect to
      Schema nameName of the schema to connect to

    5. Click on Test Database Connection button to verify the connection

    6. Wait for the connection to be verified.

    • After connection is successful, Submit button will be enabled.
    • Click on Submit button to save the data source.

    data source-1

    data source-2

    data source-3

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/data-sources/data-source-overview/index.html b/packages/noco-docs/dist/data-sources/data-source-overview/index.html index 13765f5b74..c5b3a4d460 100644 --- a/packages/noco-docs/dist/data-sources/data-source-overview/index.html +++ b/packages/noco-docs/dist/data-sources/data-source-overview/index.html @@ -4,13 +4,13 @@ Data sources overview | NocoDB - +
    -
    Version: Latest

    Data sources overview

    Overview​

    NocoDB allows you to connect to external data sources and get a unified spreadsheet view of your data. Activities related to external data sources can be managed from Data Sources tab in Base dashboard.

    Data Sources tab includes following functionalities

    1. Connect/manage external data source
    2. UI Access Control
    3. Relations
    4. Audit logs
    info

    Currently only one external data source can be added per project.

    Accessing Data Sources​

    1. Access Base context menu by clicking on the Base name in the left sidebar
    2. Click on Data Sources tab

    data source

    Learn more about working with Data sources in the following sections:

    - +
    Version: Latest

    Data sources overview

    Overview​

    NocoDB allows you to connect to external data sources and get a unified spreadsheet view of your data. Activities related to external data sources can be managed from Data Sources tab in Base dashboard.

    Data Sources tab includes following functionalities

    1. Connect/manage external data source
    2. UI Access Control
    3. Relations
    4. Audit logs
    info

    Currently only one external data source can be added per project.

    Accessing Data Sources​

    1. Access Base context menu by clicking on the Base name in the left sidebar
    2. Click on Data Sources tab

    data source

    Learn more about working with Data sources in the following sections:

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/data-sources/sync-with-data-source/index.html b/packages/noco-docs/dist/data-sources/sync-with-data-source/index.html index a78b2c7616..771d400873 100644 --- a/packages/noco-docs/dist/data-sources/sync-with-data-source/index.html +++ b/packages/noco-docs/dist/data-sources/sync-with-data-source/index.html @@ -4,14 +4,14 @@ Sync with Data source | NocoDB - +
    -
    Version: Latest

    Sync with Data source

    1. Access Base context menu by clicking on the Base name in the left sidebar
    2. Select Data Sources tab
    3. Click on Sync Metadata button listed under Actions column for the data source that you wish to sync metadata for
    4. Click on Reload button to refresh Sync state (Optional)
    5. Any changes to the metadata identified will be listed in the Sync State column
    6. Click on Sync Now button to sync the metadata changes

    sync metadata

    sync metadata

    After the sync is complete, you can see the updated state in the Sync State column.
    +

    Version: Latest

    Sync with Data source

    1. Access Base context menu by clicking on the Base name in the left sidebar
    2. Select Data Sources tab
    3. Click on Sync Metadata button listed under Actions column for the data source that you wish to sync metadata for
    4. Click on Reload button to refresh Sync state (Optional)
    5. Any changes to the metadata identified will be listed in the Sync State column
    6. Click on Sync Now button to sync the metadata changes

    sync metadata

    sync metadata

    After the sync is complete, you can see the updated state in the Sync State column.
    Sync modal also marks Tables metadata is in Sync in the header.

    post sync

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/engineering/architecture/index.html b/packages/noco-docs/dist/engineering/architecture/index.html index 283ac447e5..74746a27d0 100644 --- a/packages/noco-docs/dist/engineering/architecture/index.html +++ b/packages/noco-docs/dist/engineering/architecture/index.html @@ -4,13 +4,13 @@ Architecture overview | NocoDB - +
    -
    Version: Latest

    Architecture overview

    By default, if NC_DB is not specified, then SQLite will be used to store your metadata. We suggest users to separate the metadata and user data in different databases.

    image

    Project TypeMetadata stored inData stored in
    Create new projectNC_DBNC_DB
    Create new project with External DatabaseNC_DBExternal Database
    Create new project from ExcelNC_DBNC_DB
    - +
    Version: Latest

    Architecture overview

    By default, if NC_DB is not specified, then SQLite will be used to store your metadata. We suggest users to separate the metadata and user data in different databases.

    image

    Project TypeMetadata stored inData stored in
    Create new projectNC_DBNC_DB
    Create new project with External DatabaseNC_DBExternal Database
    Create new project from ExcelNC_DBNC_DB
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/engineering/builds-and-releases/index.html b/packages/noco-docs/dist/engineering/builds-and-releases/index.html index 33ce1e8b17..b46cffff28 100644 --- a/packages/noco-docs/dist/engineering/builds-and-releases/index.html +++ b/packages/noco-docs/dist/engineering/builds-and-releases/index.html @@ -4,13 +4,13 @@ Releases & builds | NocoDB - +
    -
    Version: Latest

    Releases & builds

    Builds of NocoDB​

    There are 3 kinds of docker builds in NocoDB

    Below is an overview of how to make these builds and what happens behind the scenes.

    Release builds​

    How to make a release build ?​

    • Click NocoDB release action

    • You should see the below screen

      image

    • Change Use workflow from to Branch: master. If you choose the wrong branch, the workflow will be ended.

      image

    • Then there would be two cases - you can either leave target tag and pervious tag blank or manually input some values

    • Target Tag means the target deployment version, while Previous Tag means the latest version as of now. Previous Tag is used for Release Note only - showing the file / commit differences between two tags.

    Tagging​

    The naming convention would be following given the actual release tag is 0.100.0

    • 0.100.0-beta.0 (first version of pre-release)
    • 0.100.0-beta.1 (include bug fix changes on top of the previous version)
    • 0.100.0-beta.2(include bug fix changes on top of the previous version)
    • and so on ...
    • 0.100.0 (actual release)
    • 0.100.1 (minor bug fix release)
    • 0.100.2 (minor bug fix release)

    Case 1: Leaving inputs blank​

    • If Previous Tag is blank, then the value will be fetched from latest
    • If Target Tag is blank, then the value will be Previous Tag plus one. Example: 0.90.11 (Previous Tag) + 0.0.1 = 0.90.12 (Target Tag)

    Case 2: Manually Input​

    Why? Sometimes we may mess up in NPM deployment. As NPM doesn't allow us to redeploy to the same tag again, in this case we cannot just use the previous tag + 1. Therefore, we need to use previous tag + 2 instead and we manually configure it.

    • After that, click Run workflow to start
    • You can see Summary for the overall job status.
    • Once release-draft-note and release-executables is finished, then go to releases, edit the draft note and save as draft for time being.
      • Example: Adding header, update content if necessary, and click Auto-generate release notes to include more info.
    • Once release-docker is finished, then test it locally first. You'll be expected to see Upgrade Available notification in UI as we haven't published the release note. (the version is retrieved from there)
    • Once everything is finished, then publish the release note and the deployment is considered as DONE.

    How does release action work ?​

    validate-branch​

    To check if github.ref is master. Otherwise, other branches will be not accepted.

    process-input​

    To enrich target tag or previous tag if necessary.

    pr-to-master​

    Automate a PR from develop to master branch so that we know the actual differences between the previous tag and the current tag. We choose master branch for a deployment base.

    release-npm​

    Build frontend and backend and release them to NPM. The changes during built such as version bumping will be committed and pushed to a temporary branch and an automated PR will be created and merged to master branch.

    Note that once you publish with a certain tag, you cannot publish with the same tag again.

    release-draft-note​

    Generate a draft release note. Some actions need to be done after this step.

    release-docker​

    Build docker image and publish it to Docker Hub. It may take around 15 - 30 mins.

    close-issues​

    Open issues marked with label Status: Fixed and Status: Resolved will be closed by bot automatically with comment mentioning the fix is included in which version.

    Example:

    image

    publish-docs​

    Publish Documentations

    update-sdk-path​

    nocodb-sdk is used in frontend and backend. However, in develop branch, the value would be file:../nocodb-sdk for development purpose (so that the changes done in nocodb-sdk in develop will be included in frontend and backend). During the deployment, the value will be changed to the target tag. This job is to update them back.

    sync-to-develop​

    Once the deployment is finished, there would be some new changes being pushed to master branch. This job is to sync the changes back to develop so that both branch won't have any difference.

    Daily builds​

    What are daily builds ?​

    • NocoDB creates every 6 hours from develop branches and publishes as nocodb/nocodb-daily
    • This is so that we can easily try what is in the develop branch easily.

    Docker images​

    • The docker images will be built and pushed to Docker Hub (See nocodb/nocodb-daily for the full list).

    Timely builds​

    What are timely builds ?​

    NocoDB has github actions which creates docker and binaries for each PR! And these can be found as a comment on the last commit of the PR.

    Example shown below

    • Go to a PR and click on the comment.

      Screenshot 2023-01-23 at 15 46 36

    • Click on the link to copy the docker image and run it locally.

      Screenshot 2023-01-23 at 15 46 55

    This is to

    • reduce pull request cycle time
    • allow issue reporters / reviewers to verify the fix without setting up their local machines

    Docker images​

    When a non-draft Pull Request is created, reopened or synchronized, a timely build for Docker would be triggered for the changes only included in the following paths.

    • packages/nocodb-sdk/**
    • packages/nc-gui/**
    • packages/nc-plugin/**
    • packages/nocodb/**

    The docker images will be built and pushed to Docker Hub (See nocodb/nocodb-timely for the full list). Once the image is ready, Github bot will add a comment with the command in the pull request. The tag would be <NOCODB_CURRENT_VERSION>-pr-<PR_NUMBER>-<YYYYMMDD>-<HHMM>.

    image

    Executables or Binaries​

    Similarly, we provide a timely build for executables for non-docker users. The source code will be built, packaged as binary files, and pushed to Github (See nocodb/nocodb-timely for the full list).

    Currently, we only support the following targets:

    • node16-linux-arm64
    • node16-macos-arm64
    • node16-win-arm64
    • node16-linux-x64
    • node16-macos-x64
    • node16-win-x64

    Once the executables are ready, Github bot will add a comment with the commands in the pull request.

    image

    NocoDB creates Docker and Binaries for each PR.

    This is to

    • reduce pull request cycle time
    • allow issue reporters / reviewers to verify the fix without setting up their local machines
    - +
    Version: Latest

    Releases & builds

    Builds of NocoDB​

    There are 3 kinds of docker builds in NocoDB

    Below is an overview of how to make these builds and what happens behind the scenes.

    Release builds​

    How to make a release build ?​

    • Click NocoDB release action

    • You should see the below screen

      image

    • Change Use workflow from to Branch: master. If you choose the wrong branch, the workflow will be ended.

      image

    • Then there would be two cases - you can either leave target tag and pervious tag blank or manually input some values

    • Target Tag means the target deployment version, while Previous Tag means the latest version as of now. Previous Tag is used for Release Note only - showing the file / commit differences between two tags.

    Tagging​

    The naming convention would be following given the actual release tag is 0.100.0

    • 0.100.0-beta.0 (first version of pre-release)
    • 0.100.0-beta.1 (include bug fix changes on top of the previous version)
    • 0.100.0-beta.2(include bug fix changes on top of the previous version)
    • and so on ...
    • 0.100.0 (actual release)
    • 0.100.1 (minor bug fix release)
    • 0.100.2 (minor bug fix release)

    Case 1: Leaving inputs blank​

    • If Previous Tag is blank, then the value will be fetched from latest
    • If Target Tag is blank, then the value will be Previous Tag plus one. Example: 0.90.11 (Previous Tag) + 0.0.1 = 0.90.12 (Target Tag)

    Case 2: Manually Input​

    Why? Sometimes we may mess up in NPM deployment. As NPM doesn't allow us to redeploy to the same tag again, in this case we cannot just use the previous tag + 1. Therefore, we need to use previous tag + 2 instead and we manually configure it.

    • After that, click Run workflow to start
    • You can see Summary for the overall job status.
    • Once release-draft-note and release-executables is finished, then go to releases, edit the draft note and save as draft for time being.
      • Example: Adding header, update content if necessary, and click Auto-generate release notes to include more info.
    • Once release-docker is finished, then test it locally first. You'll be expected to see Upgrade Available notification in UI as we haven't published the release note. (the version is retrieved from there)
    • Once everything is finished, then publish the release note and the deployment is considered as DONE.

    How does release action work ?​

    validate-branch​

    To check if github.ref is master. Otherwise, other branches will be not accepted.

    process-input​

    To enrich target tag or previous tag if necessary.

    pr-to-master​

    Automate a PR from develop to master branch so that we know the actual differences between the previous tag and the current tag. We choose master branch for a deployment base.

    release-npm​

    Build frontend and backend and release them to NPM. The changes during built such as version bumping will be committed and pushed to a temporary branch and an automated PR will be created and merged to master branch.

    Note that once you publish with a certain tag, you cannot publish with the same tag again.

    release-draft-note​

    Generate a draft release note. Some actions need to be done after this step.

    release-docker​

    Build docker image and publish it to Docker Hub. It may take around 15 - 30 mins.

    close-issues​

    Open issues marked with label Status: Fixed and Status: Resolved will be closed by bot automatically with comment mentioning the fix is included in which version.

    Example:

    image

    publish-docs​

    Publish Documentations

    update-sdk-path​

    nocodb-sdk is used in frontend and backend. However, in develop branch, the value would be file:../nocodb-sdk for development purpose (so that the changes done in nocodb-sdk in develop will be included in frontend and backend). During the deployment, the value will be changed to the target tag. This job is to update them back.

    sync-to-develop​

    Once the deployment is finished, there would be some new changes being pushed to master branch. This job is to sync the changes back to develop so that both branch won't have any difference.

    Daily builds​

    What are daily builds ?​

    • NocoDB creates every 6 hours from develop branches and publishes as nocodb/nocodb-daily
    • This is so that we can easily try what is in the develop branch easily.

    Docker images​

    • The docker images will be built and pushed to Docker Hub (See nocodb/nocodb-daily for the full list).

    Timely builds​

    What are timely builds ?​

    NocoDB has github actions which creates docker and binaries for each PR! And these can be found as a comment on the last commit of the PR.

    Example shown below

    • Go to a PR and click on the comment.

      Screenshot 2023-01-23 at 15 46 36

    • Click on the link to copy the docker image and run it locally.

      Screenshot 2023-01-23 at 15 46 55

    This is to

    • reduce pull request cycle time
    • allow issue reporters / reviewers to verify the fix without setting up their local machines

    Docker images​

    When a non-draft Pull Request is created, reopened or synchronized, a timely build for Docker would be triggered for the changes only included in the following paths.

    • packages/nocodb-sdk/**
    • packages/nc-gui/**
    • packages/nc-plugin/**
    • packages/nocodb/**

    The docker images will be built and pushed to Docker Hub (See nocodb/nocodb-timely for the full list). Once the image is ready, Github bot will add a comment with the command in the pull request. The tag would be <NOCODB_CURRENT_VERSION>-pr-<PR_NUMBER>-<YYYYMMDD>-<HHMM>.

    image

    Executables or Binaries​

    Similarly, we provide a timely build for executables for non-docker users. The source code will be built, packaged as binary files, and pushed to Github (See nocodb/nocodb-timely for the full list).

    Currently, we only support the following targets:

    • node16-linux-arm64
    • node16-macos-arm64
    • node16-win-arm64
    • node16-linux-x64
    • node16-macos-x64
    • node16-win-x64

    Once the executables are ready, Github bot will add a comment with the commands in the pull request.

    image

    NocoDB creates Docker and Binaries for each PR.

    This is to

    • reduce pull request cycle time
    • allow issue reporters / reviewers to verify the fix without setting up their local machines
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/engineering/development-setup/index.html b/packages/noco-docs/dist/engineering/development-setup/index.html index 5252f7964a..0ce4fff1ec 100644 --- a/packages/noco-docs/dist/engineering/development-setup/index.html +++ b/packages/noco-docs/dist/engineering/development-setup/index.html @@ -4,13 +4,13 @@ Development setup | NocoDB - +
    -
    Version: Latest

    Development setup

    Clone the repo​

    git clone https://github.com/nocodb/nocodb
    # change directory to the project root
    cd nocodb

    Install dependencies​

    # run from the project root
    pnpm i

    Start Frontend​

    # run from the project root
    pnpm start:frontend
    # runs on port 3000

    Start Backend​

    # run from the project root
    pnpm start:backend
    # runs on port 8080

    Any changes made to frontend and backend will be automatically reflected in the browser.

    Enabling CI-CD for Draft PR​

    CI-CD will be triggered on moving a PR from draft state to Ready for review state & on pushing changes to Develop. To verify CI-CD before requesting for review, add label trigger-CI on Draft PR.

    Accessing CI-CD Failure Screenshots​

    For Playwright tests, screenshots are captured on the tests. These will provide vital clues for debugging possible issues observed in CI-CD. To access screenshots, Open link associated with CI-CD run & click on Artifacts

    Screenshot 2022-09-29 at 12 43 37 PM

    - +
    Version: Latest

    Development setup

    Clone the repo​

    git clone https://github.com/nocodb/nocodb
    # change directory to the project root
    cd nocodb

    Install dependencies​

    # run from the project root
    pnpm i

    Start Frontend​

    # run from the project root
    pnpm start:frontend
    # runs on port 3000

    Start Backend​

    # run from the project root
    pnpm start:backend
    # runs on port 8080

    Any changes made to frontend and backend will be automatically reflected in the browser.

    Enabling CI-CD for Draft PR​

    CI-CD will be triggered on moving a PR from draft state to Ready for review state & on pushing changes to Develop. To verify CI-CD before requesting for review, add label trigger-CI on Draft PR.

    Accessing CI-CD Failure Screenshots​

    For Playwright tests, screenshots are captured on the tests. These will provide vital clues for debugging possible issues observed in CI-CD. To access screenshots, Open link associated with CI-CD run & click on Artifacts

    Screenshot 2022-09-29 at 12 43 37 PM

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/engineering/playwright/index.html b/packages/noco-docs/dist/engineering/playwright/index.html index 653154672b..42e3bf4762 100644 --- a/packages/noco-docs/dist/engineering/playwright/index.html +++ b/packages/noco-docs/dist/engineering/playwright/index.html @@ -4,13 +4,13 @@ Playwright E2E testing | NocoDB - +
    -
    Version: Latest

    Playwright E2E testing

    How to run tests​

    All the tests reside in tests/playwright folder.

    Make sure to install the dependencies (in the playwright folder):

    pnpm --filter=playwright install
    pnpm exec playwright install --with-deps chromium

    Run Test Server​

    Start the backend test server (in packages/nocodb folder):

    pnpm run watch:run:playwright

    Start the frontend test server (in packages/nc-gui folder):

    NUXT_PAGE_TRANSITION_DISABLE=true pnpm run dev

    Running all tests​

    For selecting db type, rename .env.example to .env and set E2E_DEV_DB_TYPE to sqlite(default), mysql or pg.

    headless mode(without opening browser):

    pnpm run test

    with browser:

    pnpm run test:debug

    For setting up mysql(sakila):

    docker-compose -f ./tests/playwright/scripts/docker-compose-mysql-playwright.yml  up -d

    For setting up postgres(sakila):

    docker-compose -f ./tests/playwright/scripts/docker-compose-playwright-pg.yml

    Running individual tests​

    Add .only to the test you want to run:

    test.only('should login', async ({ page }) => {
      // ...
    })
    pnpm run test

    Concepts​

    Independent tests​

    • All tests are independent of each other.
    • Each test starts with a fresh project with a fresh sakila database(option to not use sakila db is also there).
    • Each test creates a new user(email as user@nocodb.com) and logs in with that user to the dashboard.

    Caveats:

    • Some stuffs are shared i.e, users, plugins etc. So be catious while writing tests touching that. A fix for this is in the works.
    • In test, we prefix email and project with the test id, which will be deleted after the test is done.

    What to test​

    • UI verification. This includes verifying the state of the UI element, i.e if the element is visible, if the element has a particular text etc.
    • Test should verify all user flow. A test has a default timeout of 60 seconds. If a test is taking more than 60 seconds, it is a sign that the test should be broken down into smaller tests.
    • Test should also verify all the side effects the feature(i.e. On adding a new field type, should verify field deletion as well) will have, and also error cases.
    • Test name should be descriptive. It should be easy to understand what the test is doing by just reading the test name.

    Playwright​

    • Playwright is a nodejs library for automating chromium, firefox and webkit.
    • For each test, a new browser context is created. This means that each test runs in a new incognito window.
    • For assertion always use expect from @playwright/test library. This library provides a lot of useful assertions, which also has retry logic built in.

    Page Objects​

    • Page objects are used to abstract over the components/page. This makes the tests more readable and maintainable.
    • All page objects are in tests/playwright/pages folder.
    • All the test related code should be in page objects.
    • Methods should be as thin as possible and its better to have multiple methods than one big method, which improves reusability.

    The methods of a page object can be classified into 2 categories:

    • Actions: Performs an UI actions like click, type, select etc. Is also responsible for waiting for the element to be ready and the action to be performed. This included waiting for API calls to complete.
    • Assertions: Asserts the state of the UI element, i.e if the element is visible, if the element has a particular text etc. Use expect from @playwright/test and if not use expect.poll to wait for the assertion to pass.

    Writing a test​

    Let's write a test for testing filter functionality.

    For simplicity, we will have DashboardPage implemented, which will have all the methods related to dashboard page and also its child components like Grid, etc.

    Create a test suite​

    Create a new file filter.spec.ts in tests/playwright/tests folder and use setup method to create a new project and user.

    import { test, expect } from '@playwright/test';
    import setup, { NcContext } from '../setup';

    test.describe('Filter', () => {
      let context: NcContext;

      test.beforeEach(async ({ page }) => {
        context = await setup({ page });
      })

      test('should filter', async ({ page }) => {
        // ...
      });
    });

    Create a page object​

    Since filter is UI wise scoped to a Toolbar , we will add filter page object to ToolbarPage page object.

    export class ToolbarPage extends BasePage {
      readonly parent: GridPage | GalleryPage | FormPage | KanbanPage;
      readonly filter: ToolbarFilterPage;

      constructor(parent: GridPage | GalleryPage | FormPage | KanbanPage) {
        super(parent.rootPage);
        this.parent = parent;
        this.filter = new ToolbarFilterPage(this);
      }
    }

    We will create ToolbarFilterPage page object, which will have all the methods related to filter.

    export class ToolbarFilterPage extends BasePage {
      readonly toolbar: ToolbarPage;

      constructor(toolbar: ToolbarPage) {
        super(toolbar.rootPage);
        this.toolbar = toolbar;
      }
    }

    Here BasePage is an abstract class, which used to enforce structure for all page objects. Thus all page object should inherit BasePage.

    • Helper methods like waitForResponse and getClipboardText (this can be access on any page object, with this.waitForResponse)
    • Provides structure for page objects, enforces all Page objects to have rootPage property, which is the page object created in the test setup.
    • Enforces all pages to have a get method which will return the locator of the main container of that page, hence we can have focused dom selection, i.e.
    // This will only select the button inside the container of the concerned page
    await this.get().querySelector('button').count();

    Writing an action method​

    This a method which will reset/clear all the filters. Since this is an action method, it will also wait for the delete filter API to return. Ignoring this API call will cause flakiness in the test, down the line.

    async resetFilter() {
      await this.waitForResponse({
        uiAction: async () => await this.get().locator('.nc-filter-item-remove-btn').click(),
        httpMethodsToMatch: ['DELETE'],
        requestUrlPathToMatch: '/api/v1/db/meta/filters/',
      });
    }

    Writing an assertion/verification method​

    Here we use expect from @playwright/test library, which has retry logic built in.

    import { expect } from '@playwright/test';

    async verifyFilter({ title }: { title: string }) {
      await expect(
        this.get().locator(`[data-testid="nc-fields-menu-${title}"]`).locator('input[type="checkbox"]')
      ).toBeChecked();
    }

    Tips to avoid flakiness​

    • If an UI action, causes an API call or the UI state change, then wait for that API call to complete or the UI state to change.
    • What to wait out can be situation specific, but in general, is best to wait for the final state to be reached, i.e. in the case of creating filter, while it seems like waiting for the filter API to complete is enough, but after its return the table records are reloaded and the UI state changes, so its better to wait for the table records to be reloaded.

    Accessing playwright report in the CI​

    • Open Summary tab in the CI workflow in github actions.
    • Scroll down to Artifacts section.
    • Access reports which suffixed with the db type and shard number(corresponding to the CI workerflow name). i.e playwright-report-mysql-2 is for playwright-mysql-2 workflow.
    • Download it and run pnpm install -D @playwright/test && npx playwright show-report ./ inside the downloaded folder.
    - +
    Version: Latest

    Playwright E2E testing

    How to run tests​

    All the tests reside in tests/playwright folder.

    Make sure to install the dependencies (in the playwright folder):

    pnpm --filter=playwright install
    pnpm exec playwright install --with-deps chromium

    Run Test Server​

    Start the backend test server (in packages/nocodb folder):

    pnpm run watch:run:playwright

    Start the frontend test server (in packages/nc-gui folder):

    NUXT_PAGE_TRANSITION_DISABLE=true pnpm run dev

    Running all tests​

    For selecting db type, rename .env.example to .env and set E2E_DEV_DB_TYPE to sqlite(default), mysql or pg.

    headless mode(without opening browser):

    pnpm run test

    with browser:

    pnpm run test:debug

    For setting up mysql(sakila):

    docker-compose -f ./tests/playwright/scripts/docker-compose-mysql-playwright.yml  up -d

    For setting up postgres(sakila):

    docker-compose -f ./tests/playwright/scripts/docker-compose-playwright-pg.yml

    Running individual tests​

    Add .only to the test you want to run:

    test.only('should login', async ({ page }) => {
      // ...
    })
    pnpm run test

    Concepts​

    Independent tests​

    • All tests are independent of each other.
    • Each test starts with a fresh project with a fresh sakila database(option to not use sakila db is also there).
    • Each test creates a new user(email as user@nocodb.com) and logs in with that user to the dashboard.

    Caveats:

    • Some stuffs are shared i.e, users, plugins etc. So be catious while writing tests touching that. A fix for this is in the works.
    • In test, we prefix email and project with the test id, which will be deleted after the test is done.

    What to test​

    • UI verification. This includes verifying the state of the UI element, i.e if the element is visible, if the element has a particular text etc.
    • Test should verify all user flow. A test has a default timeout of 60 seconds. If a test is taking more than 60 seconds, it is a sign that the test should be broken down into smaller tests.
    • Test should also verify all the side effects the feature(i.e. On adding a new field type, should verify field deletion as well) will have, and also error cases.
    • Test name should be descriptive. It should be easy to understand what the test is doing by just reading the test name.

    Playwright​

    • Playwright is a nodejs library for automating chromium, firefox and webkit.
    • For each test, a new browser context is created. This means that each test runs in a new incognito window.
    • For assertion always use expect from @playwright/test library. This library provides a lot of useful assertions, which also has retry logic built in.

    Page Objects​

    • Page objects are used to abstract over the components/page. This makes the tests more readable and maintainable.
    • All page objects are in tests/playwright/pages folder.
    • All the test related code should be in page objects.
    • Methods should be as thin as possible and its better to have multiple methods than one big method, which improves reusability.

    The methods of a page object can be classified into 2 categories:

    • Actions: Performs an UI actions like click, type, select etc. Is also responsible for waiting for the element to be ready and the action to be performed. This included waiting for API calls to complete.
    • Assertions: Asserts the state of the UI element, i.e if the element is visible, if the element has a particular text etc. Use expect from @playwright/test and if not use expect.poll to wait for the assertion to pass.

    Writing a test​

    Let's write a test for testing filter functionality.

    For simplicity, we will have DashboardPage implemented, which will have all the methods related to dashboard page and also its child components like Grid, etc.

    Create a test suite​

    Create a new file filter.spec.ts in tests/playwright/tests folder and use setup method to create a new project and user.

    import { test, expect } from '@playwright/test';
    import setup, { NcContext } from '../setup';

    test.describe('Filter', () => {
      let context: NcContext;

      test.beforeEach(async ({ page }) => {
        context = await setup({ page });
      })

      test('should filter', async ({ page }) => {
        // ...
      });
    });

    Create a page object​

    Since filter is UI wise scoped to a Toolbar , we will add filter page object to ToolbarPage page object.

    export class ToolbarPage extends BasePage {
      readonly parent: GridPage | GalleryPage | FormPage | KanbanPage;
      readonly filter: ToolbarFilterPage;

      constructor(parent: GridPage | GalleryPage | FormPage | KanbanPage) {
        super(parent.rootPage);
        this.parent = parent;
        this.filter = new ToolbarFilterPage(this);
      }
    }

    We will create ToolbarFilterPage page object, which will have all the methods related to filter.

    export class ToolbarFilterPage extends BasePage {
      readonly toolbar: ToolbarPage;

      constructor(toolbar: ToolbarPage) {
        super(toolbar.rootPage);
        this.toolbar = toolbar;
      }
    }

    Here BasePage is an abstract class, which used to enforce structure for all page objects. Thus all page object should inherit BasePage.

    • Helper methods like waitForResponse and getClipboardText (this can be access on any page object, with this.waitForResponse)
    • Provides structure for page objects, enforces all Page objects to have rootPage property, which is the page object created in the test setup.
    • Enforces all pages to have a get method which will return the locator of the main container of that page, hence we can have focused dom selection, i.e.
    // This will only select the button inside the container of the concerned page
    await this.get().querySelector('button').count();

    Writing an action method​

    This a method which will reset/clear all the filters. Since this is an action method, it will also wait for the delete filter API to return. Ignoring this API call will cause flakiness in the test, down the line.

    async resetFilter() {
      await this.waitForResponse({
        uiAction: async () => await this.get().locator('.nc-filter-item-remove-btn').click(),
        httpMethodsToMatch: ['DELETE'],
        requestUrlPathToMatch: '/api/v1/db/meta/filters/',
      });
    }

    Writing an assertion/verification method​

    Here we use expect from @playwright/test library, which has retry logic built in.

    import { expect } from '@playwright/test';

    async verifyFilter({ title }: { title: string }) {
      await expect(
        this.get().locator(`[data-testid="nc-fields-menu-${title}"]`).locator('input[type="checkbox"]')
      ).toBeChecked();
    }

    Tips to avoid flakiness​

    • If an UI action, causes an API call or the UI state change, then wait for that API call to complete or the UI state to change.
    • What to wait out can be situation specific, but in general, is best to wait for the final state to be reached, i.e. in the case of creating filter, while it seems like waiting for the filter API to complete is enough, but after its return the table records are reloaded and the UI state changes, so its better to wait for the table records to be reloaded.

    Accessing playwright report in the CI​

    • Open Summary tab in the CI workflow in github actions.
    • Scroll down to Artifacts section.
    • Access reports which suffixed with the db type and shard number(corresponding to the CI workerflow name). i.e playwright-report-mysql-2 is for playwright-mysql-2 workflow.
    • Download it and run pnpm install -D @playwright/test && npx playwright show-report ./ inside the downloaded folder.
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/engineering/repository-structure/index.html b/packages/noco-docs/dist/engineering/repository-structure/index.html index 4d039efbf8..60c66f20d6 100644 --- a/packages/noco-docs/dist/engineering/repository-structure/index.html +++ b/packages/noco-docs/dist/engineering/repository-structure/index.html @@ -4,13 +4,13 @@ Repository structure | NocoDB - +
    -
    Version: Latest

    Repository structure

    We use Lerna to manage multi-packages. We have the following packages.

    • packages/nc-cli : A CLI to create NocoDB app.

    • packages/nocodb-sdk: API client sdk of nocodb.

    • packages/nc-gui: NocoDB Frontend.

    • packages/nc-lib-gui: The build version of nc-gui which will be used in packages/nocodb.

    • packages/nc-plugin: Plugin template.

    • packages/noco-blog: NocoDB Blog which will be auto-released to nocodb/noco-blog.

    • packages/noco-docs: NocoDB Documentation which will be auto-released to nocodb/noco-docs.

    • packages/nocodb: NocoDB Backend, hosted in NPM.

    - +
    Version: Latest

    Repository structure

    We use Lerna to manage multi-packages. We have the following packages.

    • packages/nc-cli : A CLI to create NocoDB app.

    • packages/nocodb-sdk: API client sdk of nocodb.

    • packages/nc-gui: NocoDB Frontend.

    • packages/nc-lib-gui: The build version of nc-gui which will be used in packages/nocodb.

    • packages/nc-plugin: Plugin template.

    • packages/noco-blog: NocoDB Blog which will be auto-released to nocodb/noco-blog.

    • packages/noco-docs: NocoDB Documentation which will be auto-released to nocodb/noco-docs.

    • packages/nocodb: NocoDB Backend, hosted in NPM.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/engineering/translation/index.html b/packages/noco-docs/dist/engineering/translation/index.html index bdf3b96c7d..dd485dae21 100644 --- a/packages/noco-docs/dist/engineering/translation/index.html +++ b/packages/noco-docs/dist/engineering/translation/index.html @@ -4,15 +4,15 @@ i18n translation | NocoDB - +
    -
    Version: Latest

    i18n translation

    • NocoDB supports 30+ foreign languages & community contributions are now simplified via Crowdin.

    How to add / edit translations ?​

    Using Github​

    • For English, make changes directly to en.json & commit to develop
    • For any other language, use crowdin option.

    Using Crowdin​

    Screenshot 2022-09-08 at 10 26 23 PM

    • Click the language that you wish to contribute

    Screenshot 2022-09-08 at 10 29 56 PM

    • Click the Translate button; this opens up Crowdin Online Editor

    Screenshot 2022-09-08 at 10 32 17 PM

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/engineering/unit-testing/index.html b/packages/noco-docs/dist/engineering/unit-testing/index.html index 796d7108ed..b1d7e4abdd 100644 --- a/packages/noco-docs/dist/engineering/unit-testing/index.html +++ b/packages/noco-docs/dist/engineering/unit-testing/index.html @@ -4,16 +4,16 @@ Writing unit tests | NocoDB - +
    -
    Version: Latest

    Writing unit tests

    Unit Tests​

    • All individual unit tests are independent of each other. We don't use any shared state between tests.
    • Test environment includes sakila sample database and any change to it by a test is reverted before running other tests.
    • While running unit tests, it tries to connect to mysql server running on localhost:3306 with username root and password password (which can be configured) and if not found, it will use sqlite as a fallback, hence no requirement of any sql server to run tests.

    Pre-requisites​

    • MySQL is preferred - however tests can fallback on SQLite too

    Setup​

    pnpm --filter=-nocodb install

    # add a .env file
    cp tests/unit/.env.sample tests/unit/.env

    # open .env file
    open tests/unit/.env

    Configure the following variables

    DB_HOST : host +

    Version: Latest

    Writing unit tests

    Unit Tests​

    • All individual unit tests are independent of each other. We don't use any shared state between tests.
    • Test environment includes sakila sample database and any change to it by a test is reverted before running other tests.
    • While running unit tests, it tries to connect to mysql server running on localhost:3306 with username root and password password (which can be configured) and if not found, it will use sqlite as a fallback, hence no requirement of any sql server to run tests.

    Pre-requisites​

    • MySQL is preferred - however tests can fallback on SQLite too

    Setup​

    pnpm --filter=-nocodb install

    # add a .env file
    cp tests/unit/.env.sample tests/unit/.env

    # open .env file
    open tests/unit/.env

    Configure the following variables

    DB_HOST : host DB_PORT : port DB_USER : username DB_PASSWORD : password

    Run Tests​

    pnpm run test:unit

    Folder Structure​

    The root folder for unit tests is packages/nocodb/tests/unit

    • rest folder contains all the test suites for rest apis.
    • model folder contains all the test suites for models.
    • factory folder contains all the helper functions to create test data.
    • init folder contains helper functions to configure test environment.
    • index.test.ts is the root test suite file which imports all the test suites.
    • TestDbMngr.ts is a helper class to manage test databases (i.e. creating, dropping, etc.).

    Factory Pattern​

    • Use factories for create/update/delete data. No data should be directly create/updated/deleted in the test.
    • While writing a factory make sure that it can be used with as less parameters as possible and use default values for other parameters.
    • Use named parameters for factories.
      createUser({ email, password})
    • Use one file per factory.

    Walk through of writing a Unit Test​

    We will create an Table test suite as an example.

    Configure test​

    We will configure beforeEach which is called before each test is executed. We will use init function from nocodb/packages/nocodb/tests/unit/init/index.ts, which is a helper function which configures the test environment(i.e resetting state, etc.).

    init does the following things -

    • It initializes a Noco instance(reused in all tests).
    • Restores meta and sakila database to its initial state.
    • Creates the root user.
    • Returns context which has auth token for the created user, node server instance(app), and dbConfig.

    We will use createProject and createProject factories to create a project and a table.

    let context;

    beforeEach(async function () {
      context = await init();

      project = await createProject(context);
      table = await createTable(context, project);
    });

    Test case​

    We will use it function to create a test case. We will use supertest to make a request to the server. We use expect(chai) to assert the response.

    it('Get table list', async function () {
      const response = await request(context.app)
        .get(`/api/v1/db/meta/projects/${project.id}/tables`)
        .set('xc-auth', context.token)
        .send({})
        .expect(200);

      expect(response.body.list).to.be.an('array').not.empty;
    });
    info

    We can also run individual test by using .only in describe or it function and the running the test command.

    it.only('Get table list', async () => {

    Integrating the New Test Suite​

    We create a new file table.test.ts in packages/nocodb/tests/unit/rest/tests directory.

    import 'mocha';
    import request from 'supertest';
    import init from '../../init';
    import { createTable, getAllTables } from '../../factory/table';
    import { createProject } from '../../factory/project';
    import { defaultColumns } from '../../factory/column';
    import Model from '../../../../src/lib/models/Model';
    import { expect } from 'chai';

    function tableTest() {
      let context;
      let project;
      let table;

      beforeEach(async function () {
        context = await init();

        project = await createProject(context);
        table = await createTable(context, project);
      });

      it('Get table list', async function () {
        const response = await request(context.app)
          .get(`/api/v1/db/meta/projects/${project.id}/tables`)
          .set('xc-auth', context.token)
          .send({})
          .expect(200);

        expect(response.body.list).to.be.an('array').not.empty;
      });
    }

    export default function () {
      describe('Table', tableTests);
    }

    We can then import the Table test suite to Rest test suite in packages/nocodb/tests/unit/rest/index.test.ts file(Rest test suite is imported in the root test suite file which is packages/nocodb/tests/unit/index.test.ts).

    Seeding Sample DB (Sakila)​


    function tableTest() {
      let context;
      let sakilaProject: Project;
      let customerTable: Model;

      beforeEach(async function () {
        context = await init();
        
        /******* Start : Seeding sample database **********/
        sakilaProject = await createSakilaProject(context);
        /******* End : Seeding sample database **********/
        
        customerTable = await getTable({project: sakilaProject, name: 'customer'})
      });

      it('Get table data list', async function () {
        const response = await request(context.app)
          .get(`/api/v1/db/data/noco/${sakilaProject.id}/${customerTable.id}`)
          .set('xc-auth', context.token)
          .send({})
          .expect(200);

        expect(response.body.list[0]['FirstName']).to.equal('MARY');
      });
    }
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/engineering/writing-docs/index.html b/packages/noco-docs/dist/engineering/writing-docs/index.html index 5bb84c4ebc..3bee302d60 100644 --- a/packages/noco-docs/dist/engineering/writing-docs/index.html +++ b/packages/noco-docs/dist/engineering/writing-docs/index.html @@ -4,13 +4,13 @@ Writing docs | NocoDB - +
    -
    Version: Latest

    Writing docs

    This article discusses some of the protocol and conventions to be followed while writing docs.

    Folder Structure​

    • Docs follow object-oriented approach. Each folder represents an object and each file represents procedures associated with that object.
    • Each folder contains an _category_.json file which contains the metadata for that object.
    {
      "label": "Engineering",
      "collapsible": true,
      "collapsed": true
    }

    File Structure​

    • Add following metadata to the top of each file.
    ---
    title: "Writing docs"
    description: "Overview to writing docs"
    tags: ['Engineering']
    keywords: ['Engineering', Writing docs', 'Docs conventions']
    ---
    • title is the title of the article that appears on the sidebar and on the top of the article.
    • description is the description of the article that appears in search results.
    • tags are the tags associated with the article. Tags are used to group articles together. For example, all articles with the tag Workspaces will be grouped together.
    • keywords are the keywords associated with the article. Keywords are used to improve search results. For example, if the user searches for Create workspace, then the article with the keyword Create workspace will be displayed in the search results.

    Nomenclature​

    • Folder names & file name are
      • in kebab-case.
      • prefix with a number that represents the order in which the folder/file should be displayed in the sidebar.
      • prefix number is always a 3-digit number.
      • For example, 010.account-settings.
    • Only first letter of the folder/file name is capitalized. Second letter onwards, first letter is capitalized only if it is a proper noun.

    Tags​

    • First letter of each tag is capitalized.
    • Tags usually are Objects or Actions. Add a tag only if we are sure that the tag will be used in multiple places. Example: 'Create' - we can have Create project, Create user, Create API token etc.

    Active Tags​

    Tags that are currently being used in the docs are listed below. See if you can reuse any of these tags before adding a new tag.

    Description​

    • Description should be crisp and to the point. Preferably one line.
    • Refer to the description associated with the tag to get an idea of how the description should be.
    • Descriptions appear in the search results (when searched by tags). So, it should be descriptive enough to give the user an idea of what the article is about.

    Search by tags

    Images​

    • Annotated images should be placed in img/v2 folder.
    • For every annotated image, there should be a corresponding unannotated image in the img/v2-unannotated folder.
    • Images are kept in the same folder structure as the docs.
    • Use Skitch for annotations.

    Before you commit​

    • Use npm run build to build the docs.
    • Ensure that the build is successful & there are no errors/warnings related to missing links, images, etc.
    - +
    Version: Latest

    Writing docs

    This article discusses some of the protocol and conventions to be followed while writing docs.

    Folder Structure​

    • Docs follow object-oriented approach. Each folder represents an object and each file represents procedures associated with that object.
    • Each folder contains an _category_.json file which contains the metadata for that object.
    {
      "label": "Engineering",
      "collapsible": true,
      "collapsed": true
    }

    File Structure​

    • Add following metadata to the top of each file.
    ---
    title: "Writing docs"
    description: "Overview to writing docs"
    tags: ['Engineering']
    keywords: ['Engineering', Writing docs', 'Docs conventions']
    ---
    • title is the title of the article that appears on the sidebar and on the top of the article.
    • description is the description of the article that appears in search results.
    • tags are the tags associated with the article. Tags are used to group articles together. For example, all articles with the tag Workspaces will be grouped together.
    • keywords are the keywords associated with the article. Keywords are used to improve search results. For example, if the user searches for Create workspace, then the article with the keyword Create workspace will be displayed in the search results.

    Nomenclature​

    • Folder names & file name are
      • in kebab-case.
      • prefix with a number that represents the order in which the folder/file should be displayed in the sidebar.
      • prefix number is always a 3-digit number.
      • For example, 010.account-settings.
    • Only first letter of the folder/file name is capitalized. Second letter onwards, first letter is capitalized only if it is a proper noun.

    Tags​

    • First letter of each tag is capitalized.
    • Tags usually are Objects or Actions. Add a tag only if we are sure that the tag will be used in multiple places. Example: 'Create' - we can have Create project, Create user, Create API token etc.

    Active Tags​

    Tags that are currently being used in the docs are listed below. See if you can reuse any of these tags before adding a new tag.

    Description​

    • Description should be crisp and to the point. Preferably one line.
    • Refer to the description associated with the tag to get an idea of how the description should be.
    • Descriptions appear in the search results (when searched by tags). So, it should be descriptive enough to give the user an idea of what the article is about.

    Search by tags

    Images​

    • Annotated images should be placed in img/v2 folder.
    • For every annotated image, there should be a corresponding unannotated image in the img/v2-unannotated folder.
    • Images are kept in the same folder structure as the docs.
    • Use Skitch for annotations.

    Before you commit​

    • Use npm run build to build the docs.
    • Ensure that the build is successful & there are no errors/warnings related to missing links, images, etc.
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/actions-on-field/index.html b/packages/noco-docs/dist/fields/actions-on-field/index.html index c2b0503e96..76c4c5e04a 100644 --- a/packages/noco-docs/dist/fields/actions-on-field/index.html +++ b/packages/noco-docs/dist/fields/actions-on-field/index.html @@ -4,14 +4,14 @@ Actions on field | NocoDB - +
    -
    Version: Latest

    Actions on field

    Fields context menu​

    Fields context menu can be accessed by clicking on the dropdown icon (🔽) next to the field name.
    +

    Version: Latest

    Actions on field

    Fields context menu​

    Fields context menu can be accessed by clicking on the dropdown icon (🔽) next to the field name.
    Fields context menu

    Edit​

    Rename field​

    1. Open the field context menu
    2. Click on Edit option.
    3. Enter new field name as required in the Field Name field.
    4. Click on Save Field button.

    Rename field

    Change field type​

    1. Open the field context menu
    2. Click on Edit option.
    3. Select new field type from the Field Type dropdown.
    4. Click on Save Field button.

    Change field type

    Change default value​

    1. Open the field context menu
    2. Click on Edit option.
    3. Enter new default value in the Default Value field. To disable, click on x icon.
    4. Click on Save Field button.

    Change default value

    Change field width​

    To adjust the width of the field, hover over the field edge and drag to adjust the width.

    Change field width

    Hide field​

    1. Open the field context menu
    2. Click on Hide Field option
    note
    • Hidden fields are not visible in the table view, but will still be accessible for Formulas, Sort, Filter, etc.
    • To un hide a field, use Toolbar > Fields menu
    • Fields can also be marked as hidden from Toolbar > Fields menu

    Set as Display value​

    1. Open the field context menu
    2. Click on Set as Display Value option.

    Refer to Display Value for more details.

    Sort Ascending​

    1. Open the field context menu
    2. Click on Sort Ascending option.

    Sort Descending​

    1. Open the field context menu
    2. Click on Sort Descending option.

    Duplicate field​

    1. Open the field context menu
    2. Click on Duplicate option.

    Duplicated field sans the data will be created with suffix _copy in its name & will be placed to the right of the original field.

    Insert after a field​

    1. Open the field context menu
    2. Click on Insert after option.

    New field will be created to the right of the original field.

    Insert before a field​

    1. Open the field context menu
    2. Click on Insert before option.

    New field will be created to the left of the original field.

    Delete field​

    danger

    This action cannot be undone.

    To delete a field, follow the steps below:

    1. Open the field context menu by clicking on dropdown icon (🔽) .
    2. Click on Delete.
    3. Confirm the deletion by clicking on Delete Field on the confirmation modal.
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/display-value/index.html b/packages/noco-docs/dist/fields/display-value/index.html index ed9e701f11..fbf42eeb85 100644 --- a/packages/noco-docs/dist/fields/display-value/index.html +++ b/packages/noco-docs/dist/fields/display-value/index.html @@ -4,16 +4,16 @@ Display value | NocoDB - +
    -
    Version: Latest

    Display Value

    The Display Value, as its name suggests, serves as the primary or main value within a record of a table, and it is typically the attribute by which we identify or associate that specific record. While it is advisable for the display value to be linked to a field with unique identifiers, such as a primary key, it's important to note that this uniqueness is not always enforced at the database level.

    Use of Display Value​

    • Within a spreadsheet, Display Value are always highlighted so that it is easier to recognise what record we are working with.
    • And when Links are created between two tables - it is the Display Value that appears in Linked records modal.

    Example: +

    Version: Latest

    Display Value

    The Display Value, as its name suggests, serves as the primary or main value within a record of a table, and it is typically the attribute by which we identify or associate that specific record. While it is advisable for the display value to be linked to a field with unique identifiers, such as a primary key, it's important to note that this uniqueness is not always enforced at the database level.

    Use of Display Value​

    • Within a spreadsheet, Display Value are always highlighted so that it is easier to recognise what record we are working with.
    • And when Links are created between two tables - it is the Display Value that appears in Linked records modal.

    Example: Display Value highlighted in Actor table display value

    Display Value associated when Links field
    The value shown in Link Records modal when adding a new link is associated records Display value

    display value- links field

    Set Display Value​

    Click dropdown icon (🔽) in the target field. Click Set as Display Value.

    display value set

    info

    How is Display Value identified for existing database tables ?

    • It is usually the first field after the primary key which is not a number.
    • If there is no field which is not a number then the field adjacent to primary key is chosen.

    Can I change the Display Value to another field within tables ?

    • Yes, you can use the same way mentioned above to set Display Value.
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/custom-types/QR-code/index.html b/packages/noco-docs/dist/fields/field-types/custom-types/QR-code/index.html index 12a038f8b9..e2c26ec3a2 100644 --- a/packages/noco-docs/dist/fields/field-types/custom-types/QR-code/index.html +++ b/packages/noco-docs/dist/fields/field-types/custom-types/QR-code/index.html @@ -4,14 +4,14 @@ QR code | NocoDB - +
    -
    Version: Latest

    QR code

    QR code is a custom field type that allows you to generate a QR code from a string value. This is useful for generating QR codes for things like URLs, phone numbers, or other data that can be represented as a string.

    The following field types are supported for the reference field:

    • Formula
    • Single Line Text
    • Long Text
    • Phone Number
    • URL
    • Email

    Create a QR code field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as QR Code from the dropdown.
    4. Select the field to be used as the source for the QR code.
    5. Click on Save Field button.

    image

    Cell display​

    Cell displays the QR code generated from the source field. Click on the cell to open enlarged view of the QR code.

    image
    +

    Version: Latest

    QR code

    QR code is a custom field type that allows you to generate a QR code from a string value. This is useful for generating QR codes for things like URLs, phone numbers, or other data that can be represented as a string.

    The following field types are supported for the reference field:

    • Formula
    • Single Line Text
    • Long Text
    • Phone Number
    • URL
    • Email

    Create a QR code field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as QR Code from the dropdown.
    4. Select the field to be used as the source for the QR code.
    5. Click on Save Field button.

    image

    Cell display​

    Cell displays the QR code generated from the source field. Click on the cell to open enlarged view of the QR code.

    image
    image

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/custom-types/attachment/index.html b/packages/noco-docs/dist/fields/field-types/custom-types/attachment/index.html index 0d8e09574a..9299b3ce1f 100644 --- a/packages/noco-docs/dist/fields/field-types/custom-types/attachment/index.html +++ b/packages/noco-docs/dist/fields/field-types/custom-types/attachment/index.html @@ -4,14 +4,14 @@ Attachment | NocoDB - +
    -
    Version: Latest

    Attachment

    Attachment fields allow you to upload files to your records. You can upload any file type, and the file will be linked to the record. You can also upload multiple files to a single Attachment field record.

    Create an Attachment field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Attachment from the dropdown.
    4. Click on Save Field button.

    image

    info

    Max size for an attachment file is currently limited to 5 MB

    Cell display​

    The cell display for Attachment field is either a clickable preview if file is an image in recognizable format or a file-type icon.
    +

    Version: Latest

    Attachment

    Attachment fields allow you to upload files to your records. You can upload any file type, and the file will be linked to the record. You can also upload multiple files to a single Attachment field record.

    Create an Attachment field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Attachment from the dropdown.
    4. Click on Save Field button.

    image

    info

    Max size for an attachment file is currently limited to 5 MB

    Cell display​

    The cell display for Attachment field is either a clickable preview if file is an image in recognizable format or a file-type icon.
    image

    Upload files​

    To upload files to an Attachment field,

    • Click on the + icon in the cell, choose the file to upload and click on Upload button. OR
    • Drag drop the file to the cell. OR
    • Click on expand icon <>, choose the file to upload or drag-drop file; click on Upload button.

    Expand modal​

    Expand modal for Attachment field displays the list of files uploaded to the field. You can also upload files from the expand modal. To access expand modal, click on the expand icon <> in the cell.

    image

    Expand modal supports the following actions:

    Attach file(s)​

    • Click on Attach file(s) button <1>
    • Choose the file(s) to upload

    Delete file​

    • Click on x icon <2> to the top left of the image card to delete the file

    Download file​

    • Click on Download button <5> to download the file

    Bulk Download file(s)​

    • Select the files by clicking on the checkbox <3> to the top left of the image card
    • Click on Bulk Download button <4> to download the selected files

    Rename file​

    • Click on Rename button <5> to rename the file
    • Enter the new name in the input field
    • Click on Rename button to save the new name
    note

    Rename file only renames the file in NocoDB display (expand record & tool tip on hover). It does not rename the file in the storage.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/custom-types/barcode/index.html b/packages/noco-docs/dist/fields/field-types/custom-types/barcode/index.html index ea51a4e8c9..e87a6163c4 100644 --- a/packages/noco-docs/dist/fields/field-types/custom-types/barcode/index.html +++ b/packages/noco-docs/dist/fields/field-types/custom-types/barcode/index.html @@ -4,14 +4,14 @@ Barcode | NocoDB - +
    -
    Version: Latest

    Barcode

    Barcode is a custom field type that allows you to generate a barcode from a string value. This is useful for generating barcodes for things like URLs, phone numbers, or other data that can be represented as a string.

    The following field types are supported for the for reference field:

    • Formula
    • Single Line Text
    • Long Text
    • Phone Number
    • URL
    • Email

    Create a barcode field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Barcode from the dropdown.
    4. Select the field to be used as the source for the barcode.
    5. Select the barcode type from the dropdown.
    6. Click on Save Field button.

    image

    Cell display​

    Cell displays the barcode generated from the source field. Click on the cell to open enlarged view of the QR code.

    image
    +

    Version: Latest

    Barcode

    Barcode is a custom field type that allows you to generate a barcode from a string value. This is useful for generating barcodes for things like URLs, phone numbers, or other data that can be represented as a string.

    The following field types are supported for the for reference field:

    • Formula
    • Single Line Text
    • Long Text
    • Phone Number
    • URL
    • Email

    Create a barcode field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Barcode from the dropdown.
    4. Select the field to be used as the source for the barcode.
    5. Select the barcode type from the dropdown.
    6. Click on Save Field button.

    image

    Cell display​

    Cell displays the barcode generated from the source field. Click on the cell to open enlarged view of the QR code.

    image
    image

    Supported barcode types​

    NocoDB supports the following barcode types for the barcode field type.

    • CODE128
    • EAN
    • EAN-13
    • EAN-8
    • EAN-5
    • EAN-2
    • UPC (A)
    • CODE39
    • ITF-14
    • MSI
    • Pharma code
    • Coda bar
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/custom-types/geometry/index.html b/packages/noco-docs/dist/fields/field-types/custom-types/geometry/index.html index db7f626d72..fa7fead7fd 100644 --- a/packages/noco-docs/dist/fields/field-types/custom-types/geometry/index.html +++ b/packages/noco-docs/dist/fields/field-types/custom-types/geometry/index.html @@ -4,13 +4,13 @@ Geometry | NocoDB - +
    -
    Version: Latest

    Geometry

    Create a geometry field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional)
    3. Select the field type as Geometry from the dropdown.
    4. Configure default value for the field (Optional)
    5. Click on Save Field button.

    image

    - +
    Version: Latest

    Geometry

    Create a geometry field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional)
    3. Select the field type as Geometry from the dropdown.
    4. Configure default value for the field (Optional)
    5. Click on Save Field button.

    image

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/custom-types/json/index.html b/packages/noco-docs/dist/fields/field-types/custom-types/json/index.html index 4b09e35531..92f60e433b 100644 --- a/packages/noco-docs/dist/fields/field-types/custom-types/json/index.html +++ b/packages/noco-docs/dist/fields/field-types/custom-types/json/index.html @@ -4,13 +4,13 @@ JSON | NocoDB - +
    -
    Version: Latest

    JSON

    JSON is a custom field type that allows you to store JSON data in a field. Useful for storing data that can be represented as a JSON object, like API Response, or a set of key-value pairs.

    Create a JSON field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as JSON from the dropdown.
    4. Configure default value for the field (Optional)
    5. Click on Save Field button.

    image

    Cell display​

    Cell displays the JSON data stored in the field. Click on expand record icon to open the JSON data in an editor modal.

    - +
    Version: Latest

    JSON

    JSON is a custom field type that allows you to store JSON data in a field. Useful for storing data that can be represented as a JSON object, like API Response, or a set of key-value pairs.

    Create a JSON field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as JSON from the dropdown.
    4. Configure default value for the field (Optional)
    5. Click on Save Field button.

    image

    Cell display​

    Cell displays the JSON data stored in the field. Click on expand record icon to open the JSON data in an editor modal.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/custom-types/specific-db-type/index.html b/packages/noco-docs/dist/fields/field-types/custom-types/specific-db-type/index.html index cec13a88ea..38de9db1d7 100644 --- a/packages/noco-docs/dist/fields/field-types/custom-types/specific-db-type/index.html +++ b/packages/noco-docs/dist/fields/field-types/custom-types/specific-db-type/index.html @@ -4,13 +4,13 @@ Specific DB type | NocoDB - +
    -
    Version: Latest

    Specific DB type

    Create a Specific DB Type field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Specific DB Type from the dropdown.
    4. Configure default value for the field (Optional)
    5. Provide DB specific data type configurations
    6. Click on Save Field button.

    image

    note

    Specific DB type is available only for external Data source connections

    - +
    Version: Latest

    Specific DB type

    Create a Specific DB Type field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Specific DB Type from the dropdown.
    4. Configure default value for the field (Optional)
    5. Provide DB specific data type configurations
    6. Click on Save Field button.

    image

    note

    Specific DB type is available only for external Data source connections

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/date-time-based/date-time/index.html b/packages/noco-docs/dist/fields/field-types/date-time-based/date-time/index.html index badd1a919d..04e3518fca 100644 --- a/packages/noco-docs/dist/fields/field-types/date-time-based/date-time/index.html +++ b/packages/noco-docs/dist/fields/field-types/date-time-based/date-time/index.html @@ -4,13 +4,13 @@ Date Time | NocoDB - +
    -
    Version: Latest

    Date Time

    Date Time field type is used to store both date and time values in a single field.

    Create a date time field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as DateTime from the dropdown.
    4. Configure Date Format
    5. Configure Time Format
    6. Configure default value (Optional)
    7. Click on Save Field button.

    image

    Supported date formats​

    FormatExample
    YYYY-MM-DD2023-09-22
    YYYY/MM/DD2023/09/22
    DD-MM-YYYY22-09-2023
    MM-DD-YYYY09-22-2023
    DD/MM/YYYY22/09/2023
    MM/DD/YYYY09/22/2023
    DD MM YYYY22 09 2023
    MM DD YYYY09 22 2023
    YYYY MM DD2023 09 22

    Supported time formats​

    FormatExample
    HH:mm:ss12:45:30
    HH:mm14:20
    - +
    Version: Latest

    Date Time

    Date Time field type is used to store both date and time values in a single field.

    Create a date time field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as DateTime from the dropdown.
    4. Configure Date Format
    5. Configure Time Format
    6. Configure default value (Optional)
    7. Click on Save Field button.

    image

    Supported date formats​

    FormatExample
    YYYY-MM-DD2023-09-22
    YYYY/MM/DD2023/09/22
    DD-MM-YYYY22-09-2023
    MM-DD-YYYY09-22-2023
    DD/MM/YYYY22/09/2023
    MM/DD/YYYY09/22/2023
    DD MM YYYY22 09 2023
    MM DD YYYY09 22 2023
    YYYY MM DD2023 09 22

    Supported time formats​

    FormatExample
    HH:mm:ss12:45:30
    HH:mm14:20
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/date-time-based/date/index.html b/packages/noco-docs/dist/fields/field-types/date-time-based/date/index.html index 2a43c668c0..b79fd4bffe 100644 --- a/packages/noco-docs/dist/fields/field-types/date-time-based/date/index.html +++ b/packages/noco-docs/dist/fields/field-types/date-time-based/date/index.html @@ -4,13 +4,13 @@ Date | NocoDB - +
    -
    Version: Latest

    Date

    Date field type is used to store date values. NocoDB supports a wide range of date formats, as detailed in the table below.

    Create a date field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Date from the dropdown.
    4. Configure Date Format
    5. Configure default value (Optional)
    6. Click on Save Field button.

    image

    Supported date formats​

    FormatExample
    YYYY-MM-DD2023-09-22
    YYYY/MM/DD2023/09/22
    DD-MM-YYYY22-09-2023
    MM-DD-YYYY09-22-2023
    DD/MM/YYYY22/09/2023
    MM/DD/YYYY09/22/2023
    DD MM YYYY22 09 2023
    MM DD YYYY09 22 2023
    YYYY MM DD2023 09 22
    - +
    Version: Latest

    Date

    Date field type is used to store date values. NocoDB supports a wide range of date formats, as detailed in the table below.

    Create a date field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Date from the dropdown.
    4. Configure Date Format
    5. Configure default value (Optional)
    6. Click on Save Field button.

    image

    Supported date formats​

    FormatExample
    YYYY-MM-DD2023-09-22
    YYYY/MM/DD2023/09/22
    DD-MM-YYYY22-09-2023
    MM-DD-YYYY09-22-2023
    DD/MM/YYYY22/09/2023
    MM/DD/YYYY09/22/2023
    DD MM YYYY22 09 2023
    MM DD YYYY09 22 2023
    YYYY MM DD2023 09 22
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/date-time-based/duration/index.html b/packages/noco-docs/dist/fields/field-types/date-time-based/duration/index.html index 56d39fed69..f1e6fcc051 100644 --- a/packages/noco-docs/dist/fields/field-types/date-time-based/duration/index.html +++ b/packages/noco-docs/dist/fields/field-types/date-time-based/duration/index.html @@ -4,13 +4,13 @@ Duration | NocoDB - +
    -
    Version: Latest

    Duration

    Duration field type is used to store duration of time in seconds or minutes. Different formats are supported by NocoDB, as detailed in the table below.

    Create a duration field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Duration from the dropdown.
    4. Configure Duration Format
    5. Configure default value (Optional)
    6. Click on Save Field button.

    image

    Supported duration formats​

    FormatExample
    HH:mm14:20
    HH:mm:ss12:45:30
    HH:mm:ss.s12:45:30.5
    HH:mm.ss.ss12:45.30.50
    HH:mm.ss.sss12:45.30.500
    - +
    Version: Latest

    Duration

    Duration field type is used to store duration of time in seconds or minutes. Different formats are supported by NocoDB, as detailed in the table below.

    Create a duration field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Duration from the dropdown.
    4. Configure Duration Format
    5. Configure default value (Optional)
    6. Click on Save Field button.

    image

    Supported duration formats​

    FormatExample
    HH:mm14:20
    HH:mm:ss12:45:30
    HH:mm:ss.s12:45:30.5
    HH:mm.ss.ss12:45.30.50
    HH:mm.ss.sss12:45.30.500
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/date-time-based/time/index.html b/packages/noco-docs/dist/fields/field-types/date-time-based/time/index.html index 770f281238..e24749abc4 100644 --- a/packages/noco-docs/dist/fields/field-types/date-time-based/time/index.html +++ b/packages/noco-docs/dist/fields/field-types/date-time-based/time/index.html @@ -4,13 +4,13 @@ Time | NocoDB - +
    -
    Version: Latest

    Time

    Time field type is used to store time values in a single field. Time formats supported by NocoDB are listed in the table below.

    Create a time field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional)
    3. Select the field type as Time from the dropdown.
    4. Configure default value (Optional)
    5. Click on Save Field button.

    image

    Supported time formats​

    Time format: HH:mm AM/PM (12-hour format)

    - +
    Version: Latest

    Time

    Time field type is used to store time values in a single field. Time formats supported by NocoDB are listed in the table below.

    Create a time field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional)
    3. Select the field type as Time from the dropdown.
    4. Configure default value (Optional)
    5. Click on Save Field button.

    image

    Supported time formats​

    Time format: HH:mm AM/PM (12-hour format)

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/formula/conditional-expressions/index.html b/packages/noco-docs/dist/fields/field-types/formula/conditional-expressions/index.html index 9a862be280..713c51c542 100644 --- a/packages/noco-docs/dist/fields/field-types/formula/conditional-expressions/index.html +++ b/packages/noco-docs/dist/fields/field-types/formula/conditional-expressions/index.html @@ -4,13 +4,13 @@ Conditional expressions | NocoDB - +
    -
    Version: Latest

    Conditional expressions

    Conditional expressions​

    NameSyntaxSampleOutput
    IFIF(expr, successCase, elseCase)IF({field} > 1, Value1, Value2)successCase if expr evaluates to TRUE, elseCase otherwise
    SWITCHSWITCH(expr, [pattern, value, ..., default])SWITCH({field}, 1, 'One', 2, 'Two', '--')Switch case value based on expr output
    ANDAND(expr1, [expr2,...])AND({field} > 2, {field} < 10)TRUE if all expr evaluate to TRUE
    OROR(expr1, [expr2,...])OR({field} > 2, {field} < 10)TRUE if at least one expr evaluates to TRUE
    tip

    Logical operators, along with Numerical operators can be used to build conditional expressions.

    Examples:

    IF({marksSecured} > 80, "GradeA", "GradeB")  
    SWITCH({quarterNumber},  
        1, 'Jan-Mar',
        2, 'Apr-Jun',
        3, 'Jul-Sep',
        4, 'Oct-Dec',
        'INVALID'
    )
    - +
    Version: Latest

    Conditional expressions

    Conditional expressions​

    NameSyntaxSampleOutput
    IFIF(expr, successCase, elseCase)IF({field} > 1, Value1, Value2)successCase if expr evaluates to TRUE, elseCase otherwise
    SWITCHSWITCH(expr, [pattern, value, ..., default])SWITCH({field}, 1, 'One', 2, 'Two', '--')Switch case value based on expr output
    ANDAND(expr1, [expr2,...])AND({field} > 2, {field} < 10)TRUE if all expr evaluate to TRUE
    OROR(expr1, [expr2,...])OR({field} > 2, {field} < 10)TRUE if at least one expr evaluates to TRUE
    tip

    Logical operators, along with Numerical operators can be used to build conditional expressions.

    Examples:

    IF({marksSecured} > 80, "GradeA", "GradeB")  
    SWITCH({quarterNumber},  
        1, 'Jan-Mar',
        2, 'Apr-Jun',
        3, 'Jul-Sep',
        4, 'Oct-Dec',
        'INVALID'
    )
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/formula/date-functions/index.html b/packages/noco-docs/dist/fields/field-types/formula/date-functions/index.html index 5cc0ad787c..af51198e9d 100644 --- a/packages/noco-docs/dist/fields/field-types/formula/date-functions/index.html +++ b/packages/noco-docs/dist/fields/field-types/formula/date-functions/index.html @@ -4,13 +4,13 @@ Date functions | NocoDB - +
    -
    Version: Latest

    Date functions

    NameSyntaxSampleOutputRemark
    NOWNOW()NOW()2022-05-19 17:20:43Returns the current time and day
    IF(NOW() < {DATE_COL}, "true", "false")IF(NOW() < date, "true", "false")If current date is less than {DATE_COL}, it returns true. Otherwise, it returns false.DateTime fields and negative values are supported.
    DATEADDDATEADD(date \| datetime, value, ["day" \| "week" \| "month" \| "year"])DATEADD(date, 1, 'day')Supposing {DATE_COL} is 2022-03-14. The result is 2022-03-15.DateTime fields and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'day')
    DATEADD(date, 1, 'week')Supposing {DATE_COL} is 2022-03-14 03:14. The result is 2022-03-21 03:14.DateTime fields and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'week')
    DATEADD(date, 1, 'month')Supposing {DATE_COL} is 2022-03-14 03:14. The result is 2022-04-14 03:14.DateTime fields and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'month')
    DATEADD(date, 1, 'year')Supposing {DATE_COL} is 2022-03-14 03:14. The result is 2023-03-14 03:14.DateTime fields and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'year')
    IF(NOW() < DATEADD(date,10,'day'), "true", "false")If the current date is less than {DATE_COL} plus 10 days, it returns true. Otherwise, it returns false.DateTime fields and negative values are supported.
    IF(NOW() < DATEADD(date,10,'day'), "true", "false")If the current date is less than {DATE_COL} plus 10 days, it returns true. Otherwise, it returns false.DateTime fields and negative values are supported.
    DATETIME_DIFFDATETIME_DIFF(date, date, ["milliseconds" \| "ms" \| "seconds" \| "s" \| "minutes" \| "m" \| "hours" \| "h" \| "days" \| "d" \| "weeks" \| "w" \| "months" \| "M" \| "quarters" \| "Q" \| "years" \| "y"])DATETIME_DIFF("2022/10/14", "2022/10/15", "second")Supposing {DATE_COL_1} is 2017-08-25 and {DATE_COL_2} is 2011-08-25. The result is 86400.Compares two dates and returns the difference in the unit specified. Positive integers indicate the second date being in the past compared to the first and vice versa for negative ones.
    WEEKDAY(NOW(), "sunday")If today is Monday, it returns 1Get the week day of NOW() with the first day set as sunday
    WEEKDAYWEEKDAY(date, [startDayOfWeek])WEEKDAY(NOW())If today is Monday, it returns 0Returns the day of the week as an integer between 0 and 6 inclusive starting from Monday by default. You can optionally change the start day of the week by specifying in the second argument
    WEEKDAY(NOW(), "sunday")If today is Monday, it returns 1Get the week day of NOW() with the first day set as sunday
    - +
    Version: Latest

    Date functions

    NameSyntaxSampleOutputRemark
    NOWNOW()NOW()2022-05-19 17:20:43Returns the current time and day
    IF(NOW() < {DATE_COL}, "true", "false")IF(NOW() < date, "true", "false")If current date is less than {DATE_COL}, it returns true. Otherwise, it returns false.DateTime fields and negative values are supported.
    DATEADDDATEADD(date \| datetime, value, ["day" \| "week" \| "month" \| "year"])DATEADD(date, 1, 'day')Supposing {DATE_COL} is 2022-03-14. The result is 2022-03-15.DateTime fields and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'day')
    DATEADD(date, 1, 'week')Supposing {DATE_COL} is 2022-03-14 03:14. The result is 2022-03-21 03:14.DateTime fields and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'week')
    DATEADD(date, 1, 'month')Supposing {DATE_COL} is 2022-03-14 03:14. The result is 2022-04-14 03:14.DateTime fields and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'month')
    DATEADD(date, 1, 'year')Supposing {DATE_COL} is 2022-03-14 03:14. The result is 2023-03-14 03:14.DateTime fields and negative values are supported. Example: DATEADD(DATE_TIME_COL, -1, 'year')
    IF(NOW() < DATEADD(date,10,'day'), "true", "false")If the current date is less than {DATE_COL} plus 10 days, it returns true. Otherwise, it returns false.DateTime fields and negative values are supported.
    IF(NOW() < DATEADD(date,10,'day'), "true", "false")If the current date is less than {DATE_COL} plus 10 days, it returns true. Otherwise, it returns false.DateTime fields and negative values are supported.
    DATETIME_DIFFDATETIME_DIFF(date, date, ["milliseconds" \| "ms" \| "seconds" \| "s" \| "minutes" \| "m" \| "hours" \| "h" \| "days" \| "d" \| "weeks" \| "w" \| "months" \| "M" \| "quarters" \| "Q" \| "years" \| "y"])DATETIME_DIFF("2022/10/14", "2022/10/15", "second")Supposing {DATE_COL_1} is 2017-08-25 and {DATE_COL_2} is 2011-08-25. The result is 86400.Compares two dates and returns the difference in the unit specified. Positive integers indicate the second date being in the past compared to the first and vice versa for negative ones.
    WEEKDAY(NOW(), "sunday")If today is Monday, it returns 1Get the week day of NOW() with the first day set as sunday
    WEEKDAYWEEKDAY(date, [startDayOfWeek])WEEKDAY(NOW())If today is Monday, it returns 0Returns the day of the week as an integer between 0 and 6 inclusive starting from Monday by default. You can optionally change the start day of the week by specifying in the second argument
    WEEKDAY(NOW(), "sunday")If today is Monday, it returns 1Get the week day of NOW() with the first day set as sunday
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/formula/formula/index.html b/packages/noco-docs/dist/fields/field-types/formula/formula/index.html index 5365a645ce..dd17a82f13 100644 --- a/packages/noco-docs/dist/fields/field-types/formula/formula/index.html +++ b/packages/noco-docs/dist/fields/field-types/formula/formula/index.html @@ -4,13 +4,13 @@ Formula | NocoDB - +
    -
    Version: Latest

    Formula

    Create a formula field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Formula from the dropdown.
    4. Insert required formula
    5. Click on Save Field button.

    image

    tip
    • You can use explicit numerical values/ strings as needed, e.g. 123 (numeric) or "123" (string).
    • You can reference field names in equation with {}, e.g. {field name}
    • Nested formula (formula equation referring to another formula field) is supported
    note

    Unlike other field types, formula cells cannot be modified by double-clicking since the value is generated based on the formula.

    image

    Supported formula functions​

    - +
    Version: Latest

    Formula

    Create a formula field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Formula from the dropdown.
    4. Insert required formula
    5. Click on Save Field button.

    image

    tip
    • You can use explicit numerical values/ strings as needed, e.g. 123 (numeric) or "123" (string).
    • You can reference field names in equation with {}, e.g. {field name}
    • Nested formula (formula equation referring to another formula field) is supported
    note

    Unlike other field types, formula cells cannot be modified by double-clicking since the value is generated based on the formula.

    image

    Supported formula functions​

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/formula/numeric-functions/index.html b/packages/noco-docs/dist/fields/field-types/formula/numeric-functions/index.html index 3af0126525..d183717964 100644 --- a/packages/noco-docs/dist/fields/field-types/formula/numeric-functions/index.html +++ b/packages/noco-docs/dist/fields/field-types/formula/numeric-functions/index.html @@ -4,13 +4,13 @@ Numeric functions | NocoDB - +
    -
    Version: Latest

    Numeric functions

    Numeric functions​

    NameSyntaxSampleOutput
    ABSABS(value)ABS({field})Absolute value of the input parameter
    ADDADD(value1,[value2,...])ADD({field1}, {field2})Sum of input parameters
    AVGAVG(value1,[value2,...])AVG({field1}, {field2})Average of input parameters
    CEILINGCEILING(value)CEILING({field})Rounded next largest integer value of input parameter
    EXPEXP(value)EXP({field})Exponential value of input parameter (e^x)
    FLOORFLOOR(value)FLOOR({field})Rounded largest integer less than or equal to input parameter
    INTINT(value)INT({field})Integer value of input parameter
    LOGLOG([base], value)LOG(10, {field})Logarithm of input parameter to the base (default = e) specified
    MAXMAX(value1,[value2,...])MAX({field1}, {Field2}, {Field3})Maximum value amongst input parameters
    MINMIN(value1,[value2,...])MIN({Field1}, {Field2}, {Field3})Minimum value amongst input parameters
    MODMOD(value1, value2)MOD({Field}, 2)Remainder after integer division of input parameters
    POWERPOWER(base, exponent)POWER({Field}, 3)base to the exponent power, as in base ^ exponent
    ROUNDROUND(value, precision)ROUND({Field}, 3)Round input value to decimal place specified by precision (Nearest integer if precision not provided)
    SQRTSQRT(value)SQRT({Field})Square root of the input parameter
    - +
    Version: Latest

    Numeric functions

    Numeric functions​

    NameSyntaxSampleOutput
    ABSABS(value)ABS({field})Absolute value of the input parameter
    ADDADD(value1,[value2,...])ADD({field1}, {field2})Sum of input parameters
    AVGAVG(value1,[value2,...])AVG({field1}, {field2})Average of input parameters
    CEILINGCEILING(value)CEILING({field})Rounded next largest integer value of input parameter
    EXPEXP(value)EXP({field})Exponential value of input parameter (e^x)
    FLOORFLOOR(value)FLOOR({field})Rounded largest integer less than or equal to input parameter
    INTINT(value)INT({field})Integer value of input parameter
    LOGLOG([base], value)LOG(10, {field})Logarithm of input parameter to the base (default = e) specified
    MAXMAX(value1,[value2,...])MAX({field1}, {Field2}, {Field3})Maximum value amongst input parameters
    MINMIN(value1,[value2,...])MIN({Field1}, {Field2}, {Field3})Minimum value amongst input parameters
    MODMOD(value1, value2)MOD({Field}, 2)Remainder after integer division of input parameters
    POWERPOWER(base, exponent)POWER({Field}, 3)base to the exponent power, as in base ^ exponent
    ROUNDROUND(value, precision)ROUND({Field}, 3)Round input value to decimal place specified by precision (Nearest integer if precision not provided)
    SQRTSQRT(value)SQRT({Field})Square root of the input parameter
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/formula/operators/index.html b/packages/noco-docs/dist/fields/field-types/formula/operators/index.html index 74fcf8e2ac..8d2fae9c40 100644 --- a/packages/noco-docs/dist/fields/field-types/formula/operators/index.html +++ b/packages/noco-docs/dist/fields/field-types/formula/operators/index.html @@ -4,14 +4,14 @@ Numeric and Logical Operators | NocoDB - +
    -
    Version: Latest

    Numeric and Logical Operators

    Numeric operators​

    OperatorSampleDescription
    +{field1} + {field2} + 2Addition of numeric values
    -{field1} - {field2}Subtraction of numeric values
    *{field1} * {field2}Multiplication of numeric values
    /{field1} / {field2}Division of numeric values
    tip

    To change the order of arithmetic operation, you can use round bracket parenthesis ().
    +

    Version: Latest

    Numeric and Logical Operators

    Numeric operators​

    OperatorSampleDescription
    +{field1} + {field2} + 2Addition of numeric values
    -{field1} - {field2}Subtraction of numeric values
    *{field1} * {field2}Multiplication of numeric values
    /{field1} / {field2}Division of numeric values
    tip

    To change the order of arithmetic operation, you can use round bracket parenthesis ().
    Example: ({field1} + ({field2} * {field3}) / (3 - $field4$ ))

    Logical operators​

    OperatorSampleDescription
    <{field1} < {field2}Less than
    >{field1} > {field2}Greater than
    <={field1} <= {field2}Less than or equal to
    >={field1} >= {field2}Greater than or equal to
    =={field1} == {field2}Equal to
    !={field1} != {field2}Not equal to
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/formula/string-functions/index.html b/packages/noco-docs/dist/fields/field-types/formula/string-functions/index.html index 4eac824a25..d1733f0116 100644 --- a/packages/noco-docs/dist/fields/field-types/formula/string-functions/index.html +++ b/packages/noco-docs/dist/fields/field-types/formula/string-functions/index.html @@ -4,13 +4,13 @@ String functions | NocoDB - +
    -
    Version: Latest

    String functions

    String functions​

    NameSyntaxSampleOutput
    CONCATCONCAT(str1, [str2,...])CONCAT({field1}, ' ', {field2})Concatenated string of input parameters
    LEFTLEFT(str1, n)LEFT({field}, 3)n characters from the beginning of input parameter
    LENLEN(str)LEN({field})Input parameter character length
    LOWERLOWER(str)LOWER({field})Lower case converted string of input parameter
    MIDMID(str, position, [count])MID({field}, 3, 2)Alias for SUBSTR
    REPEATREPEAT(str, count)REPEAT({field}, 2)Specified copies of the input parameter string concatenated together
    REPLACEREPLACE(str, srchStr, rplcStr)REPLACE({field}, 'int', 'num')String, after replacing all occurrences of srchStr with rplcStr
    RIGHTRIGHT(str, n)RIGHT({field}, 3)n characters from the end of input parameter
    SEARCHSEARCH(str, srchStr)SEARCH({field}, 'str')Index of srchStr specified if found, 0 otherwise
    SUBSTRSUBTR(str, position, [count])SUBSTR({field}, 3, 2)Substring of length 'count' of input string, from the postition specified
    TRIMTRIM(str)TRIM({field})Remove trailing and leading whitespaces from input parameter
    UPPERUPPER(str)UPPER({field})Upper case converted string of input parameter
    URLURL(str)URL({field})Convert to a hyperlink if it is a valid URL
    - +
    Version: Latest

    String functions

    String functions​

    NameSyntaxSampleOutput
    CONCATCONCAT(str1, [str2,...])CONCAT({field1}, ' ', {field2})Concatenated string of input parameters
    LEFTLEFT(str1, n)LEFT({field}, 3)n characters from the beginning of input parameter
    LENLEN(str)LEN({field})Input parameter character length
    LOWERLOWER(str)LOWER({field})Lower case converted string of input parameter
    MIDMID(str, position, [count])MID({field}, 3, 2)Alias for SUBSTR
    REPEATREPEAT(str, count)REPEAT({field}, 2)Specified copies of the input parameter string concatenated together
    REPLACEREPLACE(str, srchStr, rplcStr)REPLACE({field}, 'int', 'num')String, after replacing all occurrences of srchStr with rplcStr
    RIGHTRIGHT(str, n)RIGHT({field}, 3)n characters from the end of input parameter
    SEARCHSEARCH(str, srchStr)SEARCH({field}, 'str')Index of srchStr specified if found, 0 otherwise
    SUBSTRSUBTR(str, position, [count])SUBSTR({field}, 3, 2)Substring of length 'count' of input string, from the postition specified
    TRIMTRIM(str)TRIM({field})Remove trailing and leading whitespaces from input parameter
    UPPERUPPER(str)UPPER({field})Upper case converted string of input parameter
    URLURL(str)URL({field})Convert to a hyperlink if it is a valid URL
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/links-based/links/index.html b/packages/noco-docs/dist/fields/field-types/links-based/links/index.html index 86f1486e45..17761b095e 100644 --- a/packages/noco-docs/dist/fields/field-types/links-based/links/index.html +++ b/packages/noco-docs/dist/fields/field-types/links-based/links/index.html @@ -4,14 +4,14 @@ Links | NocoDB - +
    -
    Version: Latest

    Links

    Links field type is used to establish relationship between tables & create links to other records. +

    Version: Latest

    Links

    Links field type is used to establish relationship between tables & create links to other records. NocoDB supports following types of relations:

    • Has-Many - A record in one table can have multiple records in another table.
      • Example: A Country can have multiple Cities.
    • Belongs-to - Multiple records in one table can have a single record in another table.
      • Example: A City Belongs-to a Country.
    • Many-to-Many - Multiple records in one table can have multiple records in another table.
      • Example: A Student can have multiple Subjects & a Subject can have multiple Students.
    note
    • Links can be created only between tables in the same database.
    • Self-referencing links are supported. (Link to the same table)
    • For every Has-Many relation defined, NocoDB augments Belongs-to relationship field in the adjacent table automatically
    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Links from the dropdown.
    4. Select the relation type : Either Has-Many or Many-to-Many.
    5. Select the table to which the relation is to be established with.
    6. Configure label to be used for display in the cell. Defaults to Link, Links (Optional).
    7. Click on Save Field button.

    image

    Cell display​

    The cell will display number of links for a record to the related table.

    image

    Clicking on the link-text will open a Linked Records modal with the list of links & associated additional information.

    List linked records​

    image

    A brief note about the modal components:

    1. This modal is displaying linked records for PENELOPE
    2. Icon represents Many-to-Many relation
    3. Linked records belong to Film table
    4. Search bar, to narrow down the list of linked records displayed
    5. List (cards) of linked records
    6. To view additional information (expanded record), hover on the card & click on the <> icon
    7. Indicates total records linked
    8. Pagination bar
    9. Click on + Link more Records button to add new links : Read more

    Modal to add new links can be opened by

    • Clicking on + Link more Records button in the Linked Records modal
    • Clicking on the + icon in the cell (appears on clicking on the cell)

    image

    A brief note about the modal components:

    1. Links being created are for PENELOPE
    2. Icon represents Many-to-Many relation
    3. Linked records belong to Film table
    4. Search bar, to narrow down the list of records displayed
    5. Linked record card is displayed in blue color
    6. Records available for link are displayed in white color; use expand icon on the cord to view additional information
    7. Indicates total records linked (including the ones being linked)
    8. Pagination bar
    info

    Multiple records can be linked at once.

    To unlink a record, open the Linked Records modal & click on the card of the record to be unlinked.

    info

    Multiple records can be unlinked at once.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/links-based/lookup/index.html b/packages/noco-docs/dist/fields/field-types/links-based/lookup/index.html index d24c64978b..d183cdeda0 100644 --- a/packages/noco-docs/dist/fields/field-types/links-based/lookup/index.html +++ b/packages/noco-docs/dist/fields/field-types/links-based/lookup/index.html @@ -4,13 +4,13 @@ Lookup | NocoDB - +
    -
    Version: Latest

    Lookup

    Lookup fields help bring additional field information from related table into the current table. This is useful when you want to display additional information about a record in a table. For example, if you have a table of Orders and a table of Customers, you can use a Lookup field to display the customer's name and address in the Orders table.

    note
    • Lookup fields are read-only. You cannot edit the values in a lookup field.
    • Lookup fields are available only for Belongs-to relational links in hosted cloud version. The additional processing complexity for Has-many and Many-to-many relational links outweighs the benefits of having lookup fields for these links. OSS will continue to support lookup fields for all relational links.

    Create a Lookup Field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Lookup from the dropdown.
    4. Select the link field from the dropdown. This is the field that links the current table to the related table.
    5. Select the field for display from the dropdown. This is the field that will be displayed in the current table.
    6. Click on Save Field button.

    image

    - +
    Version: Latest

    Lookup

    Lookup fields help bring additional field information from related table into the current table. This is useful when you want to display additional information about a record in a table. For example, if you have a table of Orders and a table of Customers, you can use a Lookup field to display the customer's name and address in the Orders table.

    note
    • Lookup fields are read-only. You cannot edit the values in a lookup field.
    • Lookup fields are available only for Belongs-to relational links in hosted cloud version. The additional processing complexity for Has-many and Many-to-many relational links outweighs the benefits of having lookup fields for these links. OSS will continue to support lookup fields for all relational links.

    Create a Lookup Field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Lookup from the dropdown.
    4. Select the link field from the dropdown. This is the field that links the current table to the related table.
    5. Select the field for display from the dropdown. This is the field that will be displayed in the current table.
    6. Click on Save Field button.

    image

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/links-based/rollup/index.html b/packages/noco-docs/dist/fields/field-types/links-based/rollup/index.html index f3f5e8fb97..137e3f8dac 100644 --- a/packages/noco-docs/dist/fields/field-types/links-based/rollup/index.html +++ b/packages/noco-docs/dist/fields/field-types/links-based/rollup/index.html @@ -4,13 +4,13 @@ Rollup | NocoDB - +
    -
    Version: Latest

    Rollup

    Rollup fields are used to aggregate data from fields in the related table. Often used to calculate totals, averages, and other aggregate data.

    Create a Rollup Field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Lookup from the dropdown.
    4. Select the link field from the dropdown. This is the field that links the current table to the related table.
    5. Select the field for display from the dropdown. This is the field that will be displayed in the current table.
    6. Select the aggregation function from the dropdown. This is the function that will be used to aggregate the data.
    7. Click on Save Field button.

    image

    Aggregation Functions​

    Here's a table with brief descriptions for each of the aggregation functions supported by NocoDB:

    Aggregation FunctionDescription
    CountCounts the number of records in a dataset.
    MinimumRetrieves the minimum value from a dataset.
    MaximumRetrieves the maximum value from a dataset.
    AverageCalculates the average value in a dataset.
    SumAdds up all the values in a dataset.
    Count DistinctCounts the number of distinct values in a dataset.
    Sum DistinctAdds up all the distinct values in a dataset.
    Average DistinctCalculates the average of distinct values in a dataset.
    - +
    Version: Latest

    Rollup

    Rollup fields are used to aggregate data from fields in the related table. Often used to calculate totals, averages, and other aggregate data.

    Create a Rollup Field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Lookup from the dropdown.
    4. Select the link field from the dropdown. This is the field that links the current table to the related table.
    5. Select the field for display from the dropdown. This is the field that will be displayed in the current table.
    6. Select the aggregation function from the dropdown. This is the function that will be used to aggregate the data.
    7. Click on Save Field button.

    image

    Aggregation Functions​

    Here's a table with brief descriptions for each of the aggregation functions supported by NocoDB:

    Aggregation FunctionDescription
    CountCounts the number of records in a dataset.
    MinimumRetrieves the minimum value from a dataset.
    MaximumRetrieves the maximum value from a dataset.
    AverageCalculates the average value in a dataset.
    SumAdds up all the values in a dataset.
    Count DistinctCounts the number of distinct values in a dataset.
    Sum DistinctAdds up all the distinct values in a dataset.
    Average DistinctCalculates the average of distinct values in a dataset.
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/numerical/currency/index.html b/packages/noco-docs/dist/fields/field-types/numerical/currency/index.html index dc83b715d2..05a5e6844a 100644 --- a/packages/noco-docs/dist/fields/field-types/numerical/currency/index.html +++ b/packages/noco-docs/dist/fields/field-types/numerical/currency/index.html @@ -4,13 +4,13 @@ Currency | NocoDB - +
    -
    Version: Latest

    Currency

    Currency field type is used to store currency values. It is a numerical field with additional provision to set the currency symbol in display.

    Create field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Currency from the dropdown.
    4. Configure Currency Locale : defaults to en-US
    5. Configure Currency Symbol : defaults to $
    6. Set default value for the field (Optional).
    7. Click on Save Field button.

    image

    Cell display​

    image

    Supported locales​

    https://www.npmjs.com/package/locale-codes#locale-list

    note

    NocoDB adheres to ISO639-1 standard for locale codes.

    Supported currencies​

    AEDAFNALLAMDANGAOA
    ARSAUDAWGAZNBAMBBD
    BDTBGNBHDBIFBMDBND
    BOBBOVBRLBSDBTNBWP
    BYRBZDCADCDFCHECHF
    CHWCLFCLPCNYCOPCOU
    CRCCUPCVECYPCZKDJF
    DKKDOPDZDEEKEGPERN
    ETBEURFJDFKPGBPGEL
    GHCGIPGMDGNFGTQGYD
    HKDHNLHRKHTGHUFIDR
    ILSINRIQDIRRISKJMD
    JODJPYKESKGSKHRKMF
    KPWKRWKWDKYDKZTLAK
    LBPLKRLRDLSLLTLLVL
    LYDMADMDLMGAMKDMMK
    MNTMOPMROMTLMURMVR
    MWKMXNMXVMYRMZNNAD
    NGNNIONOKNPRNZDOMR
    PABPENPGKPHPPKRPLN
    PYGQARROLRONRSDRUB
    RWFSARSBDSCRSDDSEK
    SGDSHPSITSKKSLLSOS
    SRDSTDSYPSZLTHBTJS
    TMMTNDTOPTRYTTDTWD
    TZSUAHUGXUSDUSNUSS
    UYUUZSVEBVNDVUVWST
    XAFXAGXAUXBAXBBXBC
    XBDXCDXDRXFOXFUXOF
    XPDXPFXPTXTSXXXYER
    ZARZMKZWD

    Similar numerical fields​

    Following are the other numerical fields available in NocoDB, with some custom add-on features.

    - +
    Version: Latest

    Currency

    Currency field type is used to store currency values. It is a numerical field with additional provision to set the currency symbol in display.

    Create field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Currency from the dropdown.
    4. Configure Currency Locale : defaults to en-US
    5. Configure Currency Symbol : defaults to $
    6. Set default value for the field (Optional).
    7. Click on Save Field button.

    image

    Cell display​

    image

    Supported locales​

    https://www.npmjs.com/package/locale-codes#locale-list

    note

    NocoDB adheres to ISO639-1 standard for locale codes.

    Supported currencies​

    AEDAFNALLAMDANGAOA
    ARSAUDAWGAZNBAMBBD
    BDTBGNBHDBIFBMDBND
    BOBBOVBRLBSDBTNBWP
    BYRBZDCADCDFCHECHF
    CHWCLFCLPCNYCOPCOU
    CRCCUPCVECYPCZKDJF
    DKKDOPDZDEEKEGPERN
    ETBEURFJDFKPGBPGEL
    GHCGIPGMDGNFGTQGYD
    HKDHNLHRKHTGHUFIDR
    ILSINRIQDIRRISKJMD
    JODJPYKESKGSKHRKMF
    KPWKRWKWDKYDKZTLAK
    LBPLKRLRDLSLLTLLVL
    LYDMADMDLMGAMKDMMK
    MNTMOPMROMTLMURMVR
    MWKMXNMXVMYRMZNNAD
    NGNNIONOKNPRNZDOMR
    PABPENPGKPHPPKRPLN
    PYGQARROLRONRSDRUB
    RWFSARSBDSCRSDDSEK
    SGDSHPSITSKKSLLSOS
    SRDSTDSYPSZLTHBTJS
    TMMTNDTOPTRYTTDTWD
    TZSUAHUGXUSDUSNUSS
    UYUUZSVEBVNDVUVWST
    XAFXAGXAUXBAXBBXBC
    XBDXCDXDRXFOXFUXOF
    XPDXPFXPTXTSXXXYER
    ZARZMKZWD

    Similar numerical fields​

    Following are the other numerical fields available in NocoDB, with some custom add-on features.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/numerical/decimal/index.html b/packages/noco-docs/dist/fields/field-types/numerical/decimal/index.html index 4c036c88ed..d7f2201c00 100644 --- a/packages/noco-docs/dist/fields/field-types/numerical/decimal/index.html +++ b/packages/noco-docs/dist/fields/field-types/numerical/decimal/index.html @@ -4,13 +4,13 @@ Decimal | NocoDB - +
    -
    Version: Latest

    Decimal

    Decimal field type is used to store decimal values. Use cases include storing salary, price, etc. NocoDB supports precision of upto 8 digits.

    Create a decimal field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Decimal from the dropdown.
    4. Configure Precision- NocoDB supports upto 8 digits of precision.
    5. Set default value for the field (Optional).
    6. Click on Save Field button.

    image

    info
    • Default decimal precision is 1 digit

    Similar numerical fields​

    Following are the other numerical fields available in NocoDB, with some custom add-on features.

    - +
    Version: Latest

    Decimal

    Decimal field type is used to store decimal values. Use cases include storing salary, price, etc. NocoDB supports precision of upto 8 digits.

    Create a decimal field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Decimal from the dropdown.
    4. Configure Precision- NocoDB supports upto 8 digits of precision.
    5. Set default value for the field (Optional).
    6. Click on Save Field button.

    image

    info
    • Default decimal precision is 1 digit

    Similar numerical fields​

    Following are the other numerical fields available in NocoDB, with some custom add-on features.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/numerical/number/index.html b/packages/noco-docs/dist/fields/field-types/numerical/number/index.html index 8acf534a65..322025452b 100644 --- a/packages/noco-docs/dist/fields/field-types/numerical/number/index.html +++ b/packages/noco-docs/dist/fields/field-types/numerical/number/index.html @@ -4,13 +4,13 @@ Number | NocoDB - +
    -
    Version: Latest

    Number

    Number field type is used to store numerical values. Use cases include storing age, salary, price, quantity, etc.

    Create a number field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Number from the dropdown.
    4. Set default value for the field (Optional).
    5. Click on Save Field button.

    image

    info
    • This field type can hold both positive and negative numbers.
    • Supported range (JavaScript): -9007199254740991 to 9007199254740991

    Similar numerical fields​

    Following are the other numerical fields available in NocoDB, with some custom add-on features.

    - +
    Version: Latest

    Number

    Number field type is used to store numerical values. Use cases include storing age, salary, price, quantity, etc.

    Create a number field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Number from the dropdown.
    4. Set default value for the field (Optional).
    5. Click on Save Field button.

    image

    info
    • This field type can hold both positive and negative numbers.
    • Supported range (JavaScript): -9007199254740991 to 9007199254740991

    Similar numerical fields​

    Following are the other numerical fields available in NocoDB, with some custom add-on features.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/numerical/percent/index.html b/packages/noco-docs/dist/fields/field-types/numerical/percent/index.html index 60597c3bc9..2402fb49c3 100644 --- a/packages/noco-docs/dist/fields/field-types/numerical/percent/index.html +++ b/packages/noco-docs/dist/fields/field-types/numerical/percent/index.html @@ -4,13 +4,13 @@ Percent | NocoDB - +
    -
    Version: Latest

    Percent

    Percent field type is used to store percentage values. Use cases include storing discount, tax, etc.

    Create a percent field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Percent from the dropdown.
    4. Set default value for the field (Optional).
    5. Click on Save Field button.

    image

    Similar numerical fields​

    Following are the other numerical fields available in NocoDB, with some custom add-on features.

    - +
    Version: Latest

    Percent

    Percent field type is used to store percentage values. Use cases include storing discount, tax, etc.

    Create a percent field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Percent from the dropdown.
    4. Set default value for the field (Optional).
    5. Click on Save Field button.

    image

    Similar numerical fields​

    Following are the other numerical fields available in NocoDB, with some custom add-on features.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/select-based/checkbox/index.html b/packages/noco-docs/dist/fields/field-types/select-based/checkbox/index.html index f1ab208d62..fca2c2f0ee 100644 --- a/packages/noco-docs/dist/fields/field-types/select-based/checkbox/index.html +++ b/packages/noco-docs/dist/fields/field-types/select-based/checkbox/index.html @@ -4,15 +4,15 @@ Checkbox | NocoDB - +
    -
    Version: Latest

    Checkbox

    The checkbox field type is used to store boolean values. It can be used to store a simple yes/no value, or true/false, or any other boolean value.

    Create a checkbox field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Checkbox from the dropdown.
    4. Select icon for the field; defaults to check icon (Optional).
    5. Select color for the field; defaults to grey (Optional).
    6. Set default value for the field (Optional).
    7. Click on Save Field button.

    image

    Cell display​

    Cell displays the icon in the color selected for the field. A true value will be represented by a checked icon or a filled icon
    +

    Version: Latest

    Checkbox

    The checkbox field type is used to store boolean values. It can be used to store a simple yes/no value, or true/false, or any other boolean value.

    Create a checkbox field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Checkbox from the dropdown.
    4. Select icon for the field; defaults to check icon (Optional).
    5. Select color for the field; defaults to grey (Optional).
    6. Set default value for the field (Optional).
    7. Click on Save Field button.

    image

    Cell display​

    Cell displays the icon in the color selected for the field. A true value will be represented by a checked icon or a filled icon
    image

    Supported icons​

    NocoDB supports the following icons for the checkbox field type.
    image

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/select-based/multi-select/index.html b/packages/noco-docs/dist/fields/field-types/select-based/multi-select/index.html index ae20da8c72..944bffd6ce 100644 --- a/packages/noco-docs/dist/fields/field-types/select-based/multi-select/index.html +++ b/packages/noco-docs/dist/fields/field-types/select-based/multi-select/index.html @@ -4,14 +4,14 @@ Multi Select | NocoDB - +
    -
    Version: Latest

    Multi Select

    Multi Select fields allow you to select multiple options from a list of options. The options can be defined in the field configuration.

    Create a multi select field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as MultiSelect from the dropdown.
    4. Click on Add option button to add options.
    5. Set default value for the field. The options are populated in the dropdown. Since its multi select, you can select multiple options as default value (Optional).
    6. Click on Save Field button.

    image

    note

    Use of , is not allowed for option values.

    Configure color for options​

    You can re-configure background color for each option. This is useful when you want to highlight certain options. For example, you can configure High option to have red background color. +

    Version: Latest

    Multi Select

    Multi Select fields allow you to select multiple options from a list of options. The options can be defined in the field configuration.

    Create a multi select field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as MultiSelect from the dropdown.
    4. Click on Add option button to add options.
    5. Set default value for the field. The options are populated in the dropdown. Since its multi select, you can select multiple options as default value (Optional).
    6. Click on Save Field button.

    image

    note

    Use of , is not allowed for option values.

    Configure color for options​

    You can re-configure background color for each option. This is useful when you want to highlight certain options. For example, you can configure High option to have red background color. To configure, click on the color icon next to the option. Select the color from the color picker and click on Save Field button.

    image

    Re-order options​

    You can re-order options by dragging and dropping the options. To re-order, click on the drag icon next to the option and drag it to the desired position. Click on Save Field button to save the order.

    image

    info

    The order defined for the options will be used in cells dropdown as well.

    Edit options​

    You can rename options by clicking on the associated option text box. Click on Save Field button to save the changes.

    Delete options​

    You can delete options by clicking on the x icon next to the option. You can undo the delete by clicking on the undo icon next to the option. Click on Save Field button to save the changes.

    info
    • On removing an option, the option value will be removed from all the cells.
    • If the option value is set as default value for the field, then the default value will be removed.

    image

    Similar select based fields​

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/select-based/rating/index.html b/packages/noco-docs/dist/fields/field-types/select-based/rating/index.html index 5ed778f593..92c833c0d4 100644 --- a/packages/noco-docs/dist/fields/field-types/select-based/rating/index.html +++ b/packages/noco-docs/dist/fields/field-types/select-based/rating/index.html @@ -4,15 +4,15 @@ Rating | NocoDB - +
    -
    Version: Latest

    Rating

    The

    Create a checkbox field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Rating from the dropdown.
    4. Select icon for the field; defaults to star icon (Optional).
    5. Configure max count for the field; defaults to 5 (Optional).
    6. Select color for the field; defaults to grey (Optional).
    7. Set default value for the field (Optional).
    8. Click on Save Field button.

    image

    Cell display​

    Cell displays the ratings in the color & icon selected for the field.
    +

    Version: Latest

    Rating

    The

    Create a checkbox field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Rating from the dropdown.
    4. Select icon for the field; defaults to star icon (Optional).
    5. Configure max count for the field; defaults to 5 (Optional).
    6. Select color for the field; defaults to grey (Optional).
    7. Set default value for the field (Optional).
    8. Click on Save Field button.

    image

    Cell display​

    Cell displays the ratings in the color & icon selected for the field.
    image

    Setting value for the field​

    • Click on the nth rating icon to set the rating value for the field as n.
    • Key in the rating value in the cell to set the rating value for the field.
    • Paste the rating value in the cell to set the rating value for the field.

    Unsetting value for the field​

    • Click on the nth rating icon again to set the rating value for the field as 0.
    • Key in 0 in the cell to set the rating value for the field as 0.
    • Key in Delete to set the rating value for the field as 0.

    Supported icons​

    NocoDB supports the following icons for the rating field type.
    image

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/select-based/single-select/index.html b/packages/noco-docs/dist/fields/field-types/select-based/single-select/index.html index 318204e2b2..ef43194523 100644 --- a/packages/noco-docs/dist/fields/field-types/select-based/single-select/index.html +++ b/packages/noco-docs/dist/fields/field-types/select-based/single-select/index.html @@ -4,15 +4,15 @@ Single Select | NocoDB - +
    -
    Version: Latest

    Single Select

    Single select fields allow you to select a single option from a list of options. The options can be defined in the field configuration.

    Create a single select field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as SingleSelect from the dropdown.
    4. Click on Add option button to add options.
    5. Set default value for the field. The options are populated in the dropdown (Optional).
    6. Click on Save Field button.

    image

    Edit options​

    Rename options​

    You can rename options by clicking on the associated option text box. Click on Save Field button to save the changes.

    Configure color for options​

    You can re-configure background color for each option. This is useful when you want to highlight certain options. For example, you can configure High option to have red background color. +

    Version: Latest

    Single Select

    Single select fields allow you to select a single option from a list of options. The options can be defined in the field configuration.

    Create a single select field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as SingleSelect from the dropdown.
    4. Click on Add option button to add options.
    5. Set default value for the field. The options are populated in the dropdown (Optional).
    6. Click on Save Field button.

    image

    Edit options​

    Rename options​

    You can rename options by clicking on the associated option text box. Click on Save Field button to save the changes.

    Configure color for options​

    You can re-configure background color for each option. This is useful when you want to highlight certain options. For example, you can configure High option to have red background color. To configure, click on the color icon next to the option. Select the color from the color picker and click on Save Field button.

    image

    Re-order options​

    You can re-order options by dragging and dropping the options. To re-order, click on the drag icon next to the option and drag it to the desired position. Click on Save Field button to save the order.

    image

    info

    The order defined for the options will be used in cells dropdown as well.

    Edit options​

    You can rename options by clicking on the associated option text box. Click on Save Field button to save the changes.

    Delete options​

    You can delete options by clicking on the x icon next to the option. You can undo the delete by clicking on the undo icon next to the option. Click on Save Field button to save the changes.

    info
    • On removing an option, the option value will be removed from all the cells.
    • If the option value is set as default value for the field, then the default value will be removed. :::

    image

    Similar select based fields​

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/text-based/email/index.html b/packages/noco-docs/dist/fields/field-types/text-based/email/index.html index fecae46688..4f6b56ffb5 100644 --- a/packages/noco-docs/dist/fields/field-types/text-based/email/index.html +++ b/packages/noco-docs/dist/fields/field-types/text-based/email/index.html @@ -4,13 +4,13 @@ Email | NocoDB - +
    -
    Version: Latest

    Email

    Email field is text based field custom-built for storing E-mail IDs. It is a special type of Single line text field with

    • Optional validation for Email ID
    • Cell display as clickable link

    Create an Email field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Email from the dropdown.
    4. Enable validation by toggling the Validate Email checkbox (Optional).
    5. Set default value for the field (Optional).
    6. Click on Save Field button.

    image

    note
    • Specify default value without quotes.
    • Validation only ensures that the value entered is a valid email ID. It does not check if the email ID exists.

    Similar text based fields​

    Following are the other text based fields available in NocoDB, custom-built for specific use cases.

    - +
    Version: Latest

    Email

    Email field is text based field custom-built for storing E-mail IDs. It is a special type of Single line text field with

    • Optional validation for Email ID
    • Cell display as clickable link

    Create an Email field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Email from the dropdown.
    4. Enable validation by toggling the Validate Email checkbox (Optional).
    5. Set default value for the field (Optional).
    6. Click on Save Field button.

    image

    note
    • Specify default value without quotes.
    • Validation only ensures that the value entered is a valid email ID. It does not check if the email ID exists.

    Similar text based fields​

    Following are the other text based fields available in NocoDB, custom-built for specific use cases.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/text-based/long-text/index.html b/packages/noco-docs/dist/fields/field-types/text-based/long-text/index.html index 09905cf3a7..0a5824ba24 100644 --- a/packages/noco-docs/dist/fields/field-types/text-based/long-text/index.html +++ b/packages/noco-docs/dist/fields/field-types/text-based/long-text/index.html @@ -4,14 +4,14 @@ Long text | NocoDB - +
    -
    Version: Latest

    Long text

    Long Text field is text based field that allows text in multiple lines. It is useful for storing lengthy text like description, notes, etc.

    Create a Long Text field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Long text from the dropdown.
    4. Set default value for the field (Optional).
    5. Click on Save Field button.

    image

    note
    • Specify default value without quotes.
    • Use Enter key to add new line.

    Cell display​

    Long Text field is displayed as a single line text field in the table view. Click on the expand icon in the cell to view the full text.

    image +

    Version: Latest

    Long text

    Long Text field is text based field that allows text in multiple lines. It is useful for storing lengthy text like description, notes, etc.

    Create a Long Text field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Long text from the dropdown.
    4. Set default value for the field (Optional).
    5. Click on Save Field button.

    image

    note
    • Specify default value without quotes.
    • Use Enter key to add new line.

    Cell display​

    Long Text field is displayed as a single line text field in the table view. Click on the expand icon in the cell to view the full text.

    image image

    Similar text based fields​

    Following are the other text based fields available in NocoDB, custom-built for specific use cases.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/text-based/phonenumber/index.html b/packages/noco-docs/dist/fields/field-types/text-based/phonenumber/index.html index 4ee7543cdc..de2fdd5230 100644 --- a/packages/noco-docs/dist/fields/field-types/text-based/phonenumber/index.html +++ b/packages/noco-docs/dist/fields/field-types/text-based/phonenumber/index.html @@ -4,13 +4,13 @@ Phone Number | NocoDB - +
    -
    Version: Latest

    Phone Number

    Phone number field is text based field that allows you to store phone numbers. It also allows you to validate the phone number.

    Create a Phone number field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Phonenumber from the dropdown.
    4. Enable validation by toggling the Validate Phonenumber checkbox (Optional).
    5. Set default value for the field (Optional).
    6. Click on Save Field button.

    image

    note
    • Specify default value without quotes.
    • Validation only ensures that the value entered is a valid phone number. It does not check if the phone number exists.

    Similar text based fields​

    Following are the other text based fields available in NocoDB, custom-built for specific use cases.

    - +
    Version: Latest

    Phone Number

    Phone number field is text based field that allows you to store phone numbers. It also allows you to validate the phone number.

    Create a Phone number field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Phonenumber from the dropdown.
    4. Enable validation by toggling the Validate Phonenumber checkbox (Optional).
    5. Set default value for the field (Optional).
    6. Click on Save Field button.

    image

    note
    • Specify default value without quotes.
    • Validation only ensures that the value entered is a valid phone number. It does not check if the phone number exists.

    Similar text based fields​

    Following are the other text based fields available in NocoDB, custom-built for specific use cases.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/text-based/single-line-text/index.html b/packages/noco-docs/dist/fields/field-types/text-based/single-line-text/index.html index 7ba26a7101..1125802711 100644 --- a/packages/noco-docs/dist/fields/field-types/text-based/single-line-text/index.html +++ b/packages/noco-docs/dist/fields/field-types/text-based/single-line-text/index.html @@ -4,13 +4,13 @@ Single line text | NocoDB - +
    -
    Version: Latest

    Single line text

    Single line text field is a simple text based field. It can hold any text value. It is generally used for storing short text values like name, email, phone number, etc. For storing text values with multiple lines, use Long text field.

    Create a single line text field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Single line text from the dropdown.
    4. Set default value for the field (Optional).
    5. Click on Save Field button.

    image

    note

    Specify default value without quotes.

    Similar text based fields​

    Following are the other text based fields available in NocoDB, custom-built for specific use cases.

    - +
    Version: Latest

    Single line text

    Single line text field is a simple text based field. It can hold any text value. It is generally used for storing short text values like name, email, phone number, etc. For storing text values with multiple lines, use Long text field.

    Create a single line text field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as Single line text from the dropdown.
    4. Set default value for the field (Optional).
    5. Click on Save Field button.

    image

    note

    Specify default value without quotes.

    Similar text based fields​

    Following are the other text based fields available in NocoDB, custom-built for specific use cases.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/field-types/text-based/url/index.html b/packages/noco-docs/dist/fields/field-types/text-based/url/index.html index d5f0e72673..373f114967 100644 --- a/packages/noco-docs/dist/fields/field-types/text-based/url/index.html +++ b/packages/noco-docs/dist/fields/field-types/text-based/url/index.html @@ -4,13 +4,13 @@ URL | NocoDB - +
    -
    Version: Latest

    URL

    URL field is text based field custom-built for storing URLs. It is a special type of Single line text field with

    • Optional validation for URL
    • Cell display as clickable link

    Create an URL field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as URL from the dropdown.
    4. Enable validation by toggling the Validate URL checkbox (Optional).
    5. Set default value for the field (Optional).
    6. Click on Save Field button.

    image

    note
    • Specify default value without quotes.
    • Validation only ensures that the value entered is a valid URL. It does not check if the URL exists.

    Similar text based fields​

    Following are the other text based fields available in NocoDB, custom-built for specific use cases.

    - +
    Version: Latest

    URL

    URL field is text based field custom-built for storing URLs. It is a special type of Single line text field with

    • Optional validation for URL
    • Cell display as clickable link

    Create an URL field​

    1. Click on + icon to the right of Fields header
    2. On the dropdown modal, enter the field name (Optional).
    3. Select the field type as URL from the dropdown.
    4. Enable validation by toggling the Validate URL checkbox (Optional).
    5. Set default value for the field (Optional).
    6. Click on Save Field button.

    image

    note
    • Specify default value without quotes.
    • Validation only ensures that the value entered is a valid URL. It does not check if the URL exists.

    Similar text based fields​

    Following are the other text based fields available in NocoDB, custom-built for specific use cases.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/fields-overview/index.html b/packages/noco-docs/dist/fields/fields-overview/index.html index f7fa348714..4fceba69bc 100644 --- a/packages/noco-docs/dist/fields/fields-overview/index.html +++ b/packages/noco-docs/dist/fields/fields-overview/index.html @@ -4,13 +4,13 @@ Fields overview | NocoDB - +
    -
    Version: Latest

    Fields overview

    Text based​

    Numerical​

    Date and time​

    Select based​

    Custom types​

    Formula​

    - +
    Version: Latest

    Fields overview

    Text based​

    Numerical​

    Date and time​

    Select based​

    Custom types​

    Formula​

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/multi-fields-editor/index.html b/packages/noco-docs/dist/fields/multi-fields-editor/index.html index 1cc6741ab1..ae6bb5ffe3 100644 --- a/packages/noco-docs/dist/fields/multi-fields-editor/index.html +++ b/packages/noco-docs/dist/fields/multi-fields-editor/index.html @@ -4,13 +4,13 @@ Multi-field editor | NocoDB - +
    -
    Version: Latest

    Multi-field editor

    NocoDB offers a handy tool for easily managing the fields within a table. With this tool, you can add, modify, rename, arrange, or hide fields efficiently. It's particularly useful when creating a new table structure or making changes to an existing one.

    Accessing the Multi-Field Editor​

    1. Navigate to the table you wish to edit
    2. Click on Details in the navbar
    3. Select Fields tab

    Access

    Adding fields​

    On the Multi-field editor page,

    1. Click on Add Field button to add a new field.
    2. Enter the field name and select the field type; configure default value (optional).
    3. Field will be added to the end of the list. You can reorder the fields as needed. You can add / update multiple fields in one go & save all at once.
    4. Click Save changes button to save the changes.

    Add field

    tip
    • You can add / update/ delete multiple fields & save changes in one go.
    • Use Restore to discard edits to a particular field. Use Reset to discard all active changes on multi-field editor.

    Editing fields​

    On the Multi-field editor page,

    1. Click on the field you wish to edit.
    2. Make the necessary changes in the Edit Field modal. You can update the field name, type, default value, and other attributes.
    3. Updates to the field are recorded in the fields list view. You can add / update multiple fields in one go & save all at once.
    4. Click Save changes button to save the changes.

    Edit field

    tip
    • You can add / update/ delete multiple fields & save changes in one go.
    • Use Restore to discard edits to a particular field. Use Reset to discard all active changes on multi-field editor.

    Deleting fields​

    On the Multi-field editor page,

    1. Hover over the field you wish to delete, select ... icon to open context menu
    2. Click on Delete option to delete the field.
    3. Deletions in the table are recorded in the fields list view. You can delete multiple fields in one go & save all at once.
    4. Click Save changes button to save the changes.

    After all the changes are made, click Save changes button to save the changes.

    Delete field

    Delete field

    tip
    • You can add / update/ delete multiple fields & save changes in one go.
    • Use Restore to discard edits to a particular field. Use Reset to discard all active changes on multi-field editor.

    Reordering fields​

    On the Multi-field editor page, use drag-drop handle to drag and drop the fields to reorder them.

    note

    The changes will only be saved when you click Save changes button.

    Reorder fields

    Show / Hide fields​

    On the Multi-field editor page, use the toggle button next to the fields to show or hide them.

    note

    The changes will only be saved when you click Save changes button.

    Show / Hide fields

    - +
    Version: Latest

    Multi-field editor

    NocoDB offers a handy tool for easily managing the fields within a table. With this tool, you can add, modify, rename, arrange, or hide fields efficiently. It's particularly useful when creating a new table structure or making changes to an existing one.

    Accessing the Multi-Field Editor​

    1. Navigate to the table you wish to edit
    2. Click on Details in the navbar
    3. Select Fields tab

    Access

    Adding fields​

    On the Multi-field editor page,

    1. Click on Add Field button to add a new field.
    2. Enter the field name and select the field type; configure default value (optional).
    3. Field will be added to the end of the list. You can reorder the fields as needed. You can add / update multiple fields in one go & save all at once.
    4. Click Save changes button to save the changes.

    Add field

    tip
    • You can add / update/ delete multiple fields & save changes in one go.
    • Use Restore to discard edits to a particular field. Use Reset to discard all active changes on multi-field editor.

    Editing fields​

    On the Multi-field editor page,

    1. Click on the field you wish to edit.
    2. Make the necessary changes in the Edit Field modal. You can update the field name, type, default value, and other attributes.
    3. Updates to the field are recorded in the fields list view. You can add / update multiple fields in one go & save all at once.
    4. Click Save changes button to save the changes.

    Edit field

    tip
    • You can add / update/ delete multiple fields & save changes in one go.
    • Use Restore to discard edits to a particular field. Use Reset to discard all active changes on multi-field editor.

    Deleting fields​

    On the Multi-field editor page,

    1. Hover over the field you wish to delete, select ... icon to open context menu
    2. Click on Delete option to delete the field.
    3. Deletions in the table are recorded in the fields list view. You can delete multiple fields in one go & save all at once.
    4. Click Save changes button to save the changes.

    After all the changes are made, click Save changes button to save the changes.

    Delete field

    Delete field

    tip
    • You can add / update/ delete multiple fields & save changes in one go.
    • Use Restore to discard edits to a particular field. Use Reset to discard all active changes on multi-field editor.

    Reordering fields​

    On the Multi-field editor page, use drag-drop handle to drag and drop the fields to reorder them.

    note

    The changes will only be saved when you click Save changes button.

    Reorder fields

    Show / Hide fields​

    On the Multi-field editor page, use the toggle button next to the fields to show or hide them.

    note

    The changes will only be saved when you click Save changes button.

    Show / Hide fields

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/fields/primary-key/index.html b/packages/noco-docs/dist/fields/primary-key/index.html index 965c418fe3..d539765999 100644 --- a/packages/noco-docs/dist/fields/primary-key/index.html +++ b/packages/noco-docs/dist/fields/primary-key/index.html @@ -4,13 +4,13 @@ Primary key | NocoDB - +
    -
    Version: Latest

    Primary Key

    A primary key is a special database table field designated to uniquely identify each table record.

    Use of Primary Key​

    As it uniquely identifies an individual record of a table, it is used internally by NocoDB for all operations associated with a record

    Primary Key in NocoDB​

    Primary Key that gets defined / used in NocoDB depends on how underlying table was created. Summary is captured below

    1. From UI, Create new table / Import from Excel / Import from CSV
      1. An ID [datatype: Integer] system field created by default during table creation is used as primary key
      2. Additional system fields created-at, updated-at are inserted by default & can be omitted optionally; these fields can be deleted after table creation
    2. Connect to existing external database
      1. Existing primary key field defined for a table is retained as is; NocoDB doesn't insert a new ID field
      2. Additional system fields created-at, updated-at are not inserted by default
    3. Import from Airtable
      1. Airtable record ID is marked as primary key for imported records, and is mapped to field ncRecordId [datatype: varchar]
      2. If a new record is inserted after migration & if ncRecordId field was omitted during record insertion - auto generated string will be inserted by NocoDB
      3. Computed hash value for the entire record is stored in system field ncRecordHash
      4. Additional system fields created-at, updated-at are not inserted by default
    4. Create new table using SDK / API
      1. No default primary key field is introduced by NocoDB. It has to be explicitly specified during table creation (using attribute pk: true)
    info

    What if Primary Key was missing?

    It is possible to have a table without any primary key.

    • External database table can be created without primary key configuration.

    • New table can be created using SDK / API without primary key

      In such scenario's, new records can be created in NocoDB for this table, but records can't be updated or deleted as there is no way for NocoDB to uniquely identify these records

    info

    Can I change the Primary Key to another field within tables?

    • You can't update Primary Key from NocoDB UI. You can reconfigure it at database level directly & trigger meta sync explicitly.
    - +
    Version: Latest

    Primary Key

    A primary key is a special database table field designated to uniquely identify each table record.

    Use of Primary Key​

    As it uniquely identifies an individual record of a table, it is used internally by NocoDB for all operations associated with a record

    Primary Key in NocoDB​

    Primary Key that gets defined / used in NocoDB depends on how underlying table was created. Summary is captured below

    1. From UI, Create new table / Import from Excel / Import from CSV
      1. An ID [datatype: Integer] system field created by default during table creation is used as primary key
      2. Additional system fields created-at, updated-at are inserted by default & can be omitted optionally; these fields can be deleted after table creation
    2. Connect to existing external database
      1. Existing primary key field defined for a table is retained as is; NocoDB doesn't insert a new ID field
      2. Additional system fields created-at, updated-at are not inserted by default
    3. Import from Airtable
      1. Airtable record ID is marked as primary key for imported records, and is mapped to field ncRecordId [datatype: varchar]
      2. If a new record is inserted after migration & if ncRecordId field was omitted during record insertion - auto generated string will be inserted by NocoDB
      3. Computed hash value for the entire record is stored in system field ncRecordHash
      4. Additional system fields created-at, updated-at are not inserted by default
    4. Create new table using SDK / API
      1. No default primary key field is introduced by NocoDB. It has to be explicitly specified during table creation (using attribute pk: true)
    info

    What if Primary Key was missing?

    It is possible to have a table without any primary key.

    • External database table can be created without primary key configuration.

    • New table can be created using SDK / API without primary key

      In such scenario's, new records can be created in NocoDB for this table, but records can't be updated or deleted as there is no way for NocoDB to uniquely identify these records

    info

    Can I change the Primary Key to another field within tables?

    • You can't update Primary Key from NocoDB UI. You can reconfigure it at database level directly & trigger meta sync explicitly.
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/getting-started/keyboard-shortcuts/index.html b/packages/noco-docs/dist/getting-started/keyboard-shortcuts/index.html index eb2989a72b..5ed278cc81 100644 --- a/packages/noco-docs/dist/getting-started/keyboard-shortcuts/index.html +++ b/packages/noco-docs/dist/getting-started/keyboard-shortcuts/index.html @@ -4,13 +4,13 @@ Keyboard shortcuts | NocoDB - +
    -
    Version: Latest

    Keyboard shortcuts

    Quick Actions​

    note

    This feature is available only in NocoDB Cloud hosted version.

    ⌘ + K (or Ctrl + K on Windows) is a keyboard shortcut to quickly navigate between different workspace, table, view, or a menu items. For example, if you want to quickly navigate to the "API Tokens" page, you can open Quick Actions menu using ⌘+K, type "Token" in the search box and press enter.

    This shortcut is often referred to as "Command-K". It's a great way to save time when you're navigating around NocoDB.

    Command-K menu can also be accessed via the "Quick Actions" button in the top left corner of the screen.

    Quick Actions

    To navigate within ⌘+K menu,

    • Use ↑ ↓ to navigate between listed items
    • Use Enter to select an item
    • Use Backspace to move to parent menu
    • Use Esc to close the menu

    Recent Views​

    note

    This feature is available only in NocoDB Cloud hosted version.

    Access recently visited views quickly using ⌘ + L (or Ctrl + L on Windows). Search results will be displayed in a modal window; click on the result to open the view.

    Recent Views

    To navigate within ⌘+K menu,

    • Use ↑ ↓ to navigate between listed items
    • Use Enter to select an item
    • Use Backspace to move to parent menu
    • Use Esc to close the menu

    Search in Docs​

    note

    This feature is available only in NocoDB Cloud hosted version.

    Quickly search through docs from within NocoDB UI using ⌘ + J (or Ctrl + J on Windows). Search results will be displayed in a modal window; click on the result to open the page in a new tab.

    To navigate within ⌘+K menu,

    • Use ↑ ↓ to navigate between listed items
    • Use Enter to select an item
    • Use Backspace to move to parent menu
    • Use Esc to close the menu

    Search in Docs

    General shortcuts​

    KeyBehaviour
    alt + tOpens new table modal
    alt + cOpens new field modal
    alt + fToggles fullscreen mode
    alt + iOpens share button modal
    ⌘ + kOpens Quick Actions modal

    Grid view shortcuts​

    KeyBehaviour
    ← → ↑ ↓General cell navigation
    DeleteClear cell
    SpaceExpand current record
    TabMove to next cell horizontally; if on last cell, move to beginning of next record
    EscExit cell EDIT mode
    EnterSwitch cell in focus to EDIT mode; opens modal/picker if cell is associated with one
    ⌘ + ↑Jump to first record in this field (in same page)
    ⌘ + ↓Jump to last record in this field (in same page)
    ⌘ + ←Jump to first field in this record
    ⌘ + →Jump to last field in this record
    ⌘ + cCopy cell contents
    ⌘ + vPaste copied contents
    alt + rInserts new record in grid view

    Field type specific shortcuts​

    DatatypeKeyBehaviour
    Text & Numerical cells← →Move cursor to the left / right
    ↑ ↓Move cursor to the beginning / end
    Single Select↑ ↓Move between options
    EnterSelect option
    Multi Select↑ ↓Move between options
    EnterSelect / deselect option
    Link↑ ↓Move between options
    EnterLink current selection
    CheckboxEnterToggle
    Rating<0 ~ Max>Enter number to toggle rating

    Expanded form shortcuts​

    KeyBehaviour
    ⌘ + EnterSave current expanded form item
    alt + →Switch to next record
    alt + ←Switch to previous record
    alt + SSave current expanded form record
    alt + NCreate a new record
    - +
    Version: Latest

    Keyboard shortcuts

    Quick Actions​

    note

    This feature is available only in NocoDB Cloud hosted version.

    ⌘ + K (or Ctrl + K on Windows) is a keyboard shortcut to quickly navigate between different workspace, table, view, or a menu items. For example, if you want to quickly navigate to the "API Tokens" page, you can open Quick Actions menu using ⌘+K, type "Token" in the search box and press enter.

    This shortcut is often referred to as "Command-K". It's a great way to save time when you're navigating around NocoDB.

    Command-K menu can also be accessed via the "Quick Actions" button in the top left corner of the screen.

    Quick Actions

    To navigate within ⌘+K menu,

    • Use ↑ ↓ to navigate between listed items
    • Use Enter to select an item
    • Use Backspace to move to parent menu
    • Use Esc to close the menu

    Recent Views​

    note

    This feature is available only in NocoDB Cloud hosted version.

    Access recently visited views quickly using ⌘ + L (or Ctrl + L on Windows). Search results will be displayed in a modal window; click on the result to open the view.

    Recent Views

    To navigate within ⌘+K menu,

    • Use ↑ ↓ to navigate between listed items
    • Use Enter to select an item
    • Use Backspace to move to parent menu
    • Use Esc to close the menu

    Search in Docs​

    note

    This feature is available only in NocoDB Cloud hosted version.

    Quickly search through docs from within NocoDB UI using ⌘ + J (or Ctrl + J on Windows). Search results will be displayed in a modal window; click on the result to open the page in a new tab.

    To navigate within ⌘+K menu,

    • Use ↑ ↓ to navigate between listed items
    • Use Enter to select an item
    • Use Backspace to move to parent menu
    • Use Esc to close the menu

    Search in Docs

    General shortcuts​

    KeyBehaviour
    alt + tOpens new table modal
    alt + cOpens new field modal
    alt + fToggles fullscreen mode
    alt + iOpens share button modal
    ⌘ + kOpens Quick Actions modal

    Grid view shortcuts​

    KeyBehaviour
    ← → ↑ ↓General cell navigation
    DeleteClear cell
    SpaceExpand current record
    TabMove to next cell horizontally; if on last cell, move to beginning of next record
    EscExit cell EDIT mode
    EnterSwitch cell in focus to EDIT mode; opens modal/picker if cell is associated with one
    ⌘ + ↑Jump to first record in this field (in same page)
    ⌘ + ↓Jump to last record in this field (in same page)
    ⌘ + ←Jump to first field in this record
    ⌘ + →Jump to last field in this record
    ⌘ + cCopy cell contents
    ⌘ + vPaste copied contents
    alt + rInserts new record in grid view

    Field type specific shortcuts​

    DatatypeKeyBehaviour
    Text & Numerical cells← →Move cursor to the left / right
    ↑ ↓Move cursor to the beginning / end
    Single Select↑ ↓Move between options
    EnterSelect option
    Multi Select↑ ↓Move between options
    EnterSelect / deselect option
    Link↑ ↓Move between options
    EnterLink current selection
    CheckboxEnterToggle
    Rating<0 ~ Max>Enter number to toggle rating

    Expanded form shortcuts​

    KeyBehaviour
    ⌘ + EnterSave current expanded form item
    alt + →Switch to next record
    alt + ←Switch to previous record
    alt + SSave current expanded form record
    alt + NCreate a new record
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/getting-started/quick-start/index.html b/packages/noco-docs/dist/getting-started/quick-start/index.html index fda7ff225e..5e9b3a7539 100644 --- a/packages/noco-docs/dist/getting-started/quick-start/index.html +++ b/packages/noco-docs/dist/getting-started/quick-start/index.html @@ -4,13 +4,13 @@ Quick start | NocoDB - +
    -
    Version: Latest

    Quick start

    NocoDB offers you the flexibility of two distinct variants: self-hosted and SaaS (cloud-hosted). In this section, we'll walk you through the initial steps to embark on your NocoDB journey, whether you choose to set it up on your own infrastructure or opt for the convenience of our cloud-hosted service. Let's dive in and unlock the potential of NocoDB for your data management needs.

    tip

    For this introductory guide, we suggest utilizing the hosted (SaaS) option. New users can take advantage of a complimentary trial period to explore the platform's features.

    Self Hosted​

    When you opt for self-hosting, you gain the advantage of running an application on a server that you have direct control over. This grants you the flexibility to choose whether to host the database on your premises or within a server leased from a data center. In this self-administered arrangement, typically found on-premises, you assume full responsibility for the management and upkeep of your server. This level of control ensures that you have complete authority over all aspects of your data and services, eliminating any reliance on third-party service providers. This option is ideal for organizations that require a high degree of control over their data and services, but it does necessitate a higher level of technical expertise.

    Setting up NocoDB on your own server is a straightforward process & the articles below will guide you through the steps to get started.

    SaaS (Cloud Hosted)​

    Sign up for a NocoDB account​

    To get started with NocoDB's cloud-hosted service, follow these steps to sign up for an account:

    1. Visit the NocoDB website.
    2. Click on the "Start For Free" button located in the top right corner.
    3. Sign Up using Google account. Alternatively, you can also sign up using your email address.
    4. Check your email for a verification link and follow the instructions to verify your account.

    Once you've successfully signed up, you will land on the NocoDB dashboard with a default workspace created for you.

    Create another workspace​

    After signing up and logging in to your NocoDB account, a default workspace is automatically created for you. You can use this workspace or create a new one

    Your new workspace is now ready, and you can start building your base within it.

    Build a Base​

    Building a base in NocoDB is where you define the structure of your database, create tables to store your data, add fields to those tables, and establish relationships between tables using Links. This relational approach helps you organize and manage your data effectively, making it easier to work with complex datasets and build powerful applications. Add a new Base. Alternatively, you can also import existing base from Airtable as a NocoDB project in minutes.

    Create Tables​

    Tables are where you store your data like a spreadsheet grid, with data arranged in rows & columns. Once the base is created, you can start adding new tables to it. You can also import existing structure data from a CSV, Excel, or JSON file to populate your tables.

    Add Fields​

    Within each table, define the fields that will hold your data. Fields are columnar data containers that hold a specific type of data. Fields can represent various types of information, such as text, numbers, dates, and more. You can find complete list of supported field types here.

    Use multi-fields editor to manage fields in bulk quickly - add fields, edit them, reorder, change visibility, reconfigure - all from one single window. Read more.

    One of NocoDB's powerful features is the ability to establish relationships between tables using Links. Links enable you to connect related data across tables. For example, you can link "Tasks" to a specific "Project" by creating a Link field in the "Projects" table that points to the "Tasks" table.

    Add Records​

    Once you have created tables and defined the necessary fields, it's time to start adding records to your base tables. Records are individual entries or rows within your tables, and they contain the actual data you want to store and manage. You can add records manually or upload existing data sets from CSV files.

    Create views​

    Views are customized ways of displaying your data. You can create multiple views for each table in your base, and each view can have its own set of fields, filters, and layouts. NocoDB offers a variety of view types for custom display, including Grid, Kanban, and Gallery. If you are collecting data from a form, you can also create a Form view to display the data in a form format.

    Connect your data sources​

    Not just creating base & tables from the scratch, NocoDB also allows you to get started quickly by connecting to your existing data sources & bring the comfort of spreadsheet UI to your data source.

    Collaborate with your team​

    NocoDB makes it easy to collaborate with your team members on your workspaces and bases. You can invite team members to your workspace and share your bases with them. You can also assign roles and permissions to your team members to control their access to your bases.

    Want to share information publicly? You can create a public link to your base and share it with anyone. You can also embed your base on your website or blog.

    That's it! You're now ready to harness the power of NocoDB for your data management needs.

    - +
    Version: Latest

    Quick start

    NocoDB offers you the flexibility of two distinct variants: self-hosted and SaaS (cloud-hosted). In this section, we'll walk you through the initial steps to embark on your NocoDB journey, whether you choose to set it up on your own infrastructure or opt for the convenience of our cloud-hosted service. Let's dive in and unlock the potential of NocoDB for your data management needs.

    tip

    For this introductory guide, we suggest utilizing the hosted (SaaS) option. New users can take advantage of a complimentary trial period to explore the platform's features.

    Self Hosted​

    When you opt for self-hosting, you gain the advantage of running an application on a server that you have direct control over. This grants you the flexibility to choose whether to host the database on your premises or within a server leased from a data center. In this self-administered arrangement, typically found on-premises, you assume full responsibility for the management and upkeep of your server. This level of control ensures that you have complete authority over all aspects of your data and services, eliminating any reliance on third-party service providers. This option is ideal for organizations that require a high degree of control over their data and services, but it does necessitate a higher level of technical expertise.

    Setting up NocoDB on your own server is a straightforward process & the articles below will guide you through the steps to get started.

    SaaS (Cloud Hosted)​

    Sign up for a NocoDB account​

    To get started with NocoDB's cloud-hosted service, follow these steps to sign up for an account:

    1. Visit the NocoDB website.
    2. Click on the "Start For Free" button located in the top right corner.
    3. Sign Up using Google account. Alternatively, you can also sign up using your email address.
    4. Check your email for a verification link and follow the instructions to verify your account.

    Once you've successfully signed up, you will land on the NocoDB dashboard with a default workspace created for you.

    Create another workspace​

    After signing up and logging in to your NocoDB account, a default workspace is automatically created for you. You can use this workspace or create a new one

    Your new workspace is now ready, and you can start building your base within it.

    Build a Base​

    Building a base in NocoDB is where you define the structure of your database, create tables to store your data, add fields to those tables, and establish relationships between tables using Links. This relational approach helps you organize and manage your data effectively, making it easier to work with complex datasets and build powerful applications. Add a new Base. Alternatively, you can also import existing base from Airtable as a NocoDB project in minutes.

    Create Tables​

    Tables are where you store your data like a spreadsheet grid, with data arranged in rows & columns. Once the base is created, you can start adding new tables to it. You can also import existing structure data from a CSV, Excel, or JSON file to populate your tables.

    Add Fields​

    Within each table, define the fields that will hold your data. Fields are columnar data containers that hold a specific type of data. Fields can represent various types of information, such as text, numbers, dates, and more. You can find complete list of supported field types here.

    Use multi-fields editor to manage fields in bulk quickly - add fields, edit them, reorder, change visibility, reconfigure - all from one single window. Read more.

    One of NocoDB's powerful features is the ability to establish relationships between tables using Links. Links enable you to connect related data across tables. For example, you can link "Tasks" to a specific "Project" by creating a Link field in the "Projects" table that points to the "Tasks" table.

    Add Records​

    Once you have created tables and defined the necessary fields, it's time to start adding records to your base tables. Records are individual entries or rows within your tables, and they contain the actual data you want to store and manage. You can add records manually or upload existing data sets from CSV files.

    Create views​

    Views are customized ways of displaying your data. You can create multiple views for each table in your base, and each view can have its own set of fields, filters, and layouts. NocoDB offers a variety of view types for custom display, including Grid, Kanban, and Gallery. If you are collecting data from a form, you can also create a Form view to display the data in a form format.

    Connect your data sources​

    Not just creating base & tables from the scratch, NocoDB also allows you to get started quickly by connecting to your existing data sources & bring the comfort of spreadsheet UI to your data source.

    Collaborate with your team​

    NocoDB makes it easy to collaborate with your team members on your workspaces and bases. You can invite team members to your workspace and share your bases with them. You can also assign roles and permissions to your team members to control their access to your bases.

    Want to share information publicly? You can create a public link to your base and share it with anyone. You can also embed your base on your website or blog.

    That's it! You're now ready to harness the power of NocoDB for your data management needs.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/getting-started/self-hosted/environment-variables/index.html b/packages/noco-docs/dist/getting-started/self-hosted/environment-variables/index.html index 587f8dae9e..32287ca95c 100644 --- a/packages/noco-docs/dist/getting-started/self-hosted/environment-variables/index.html +++ b/packages/noco-docs/dist/getting-started/self-hosted/environment-variables/index.html @@ -4,13 +4,13 @@ Environment variables | NocoDB - +
    -
    Version: Latest

    Environment variables

    For production use-cases, it is recommended to configure

    • NC_DB,
    • NC_AUTH_JWT_SECRET,
    • NC_PUBLIC_URL,
    • NC_REDIS_URL
    VariableCommentsIf absent
    NC_DBSee our example database URLs here.A local SQLite will be created in root folder if NC_DB is not provided
    NC_DB_JSONCan be used instead of NC_DB and value should be valid knex connection JSON
    NC_DB_JSON_FILECan be used instead of NC_DB and value should be a valid path to knex connection JSON
    DATABASE_URLCan be used instead of NC_DB and value should be in JDBC URL format
    DATABASE_URL_FILECan be used instead of DATABASE_URL and value should be a valid path to file containing JDBC URL format.
    NC_AUTH_JWT_SECRETJWT secret used for auth and storing other secretsA random secret will be generated
    PORTFor setting app running port8080
    DB_QUERY_LIMIT_DEFAULTPagination limit25
    DB_QUERY_LIMIT_MAXMaximum allowed pagination limit1000
    DB_QUERY_LIMIT_MINMinimum allowed pagination limit1
    NC_TOOL_DIRApp directory to keep metadata and app related filesDefaults to current working directory. In docker maps to /usr/app/data/ for mounting volume.
    NC_PUBLIC_URLUsed for sending Email invitationsBest guess from http request params
    NC_JWT_EXPIRES_INJWT token expiry time10h
    NC_CONNECT_TO_EXTERNAL_DB_DISABLEDDisable Project creation with external database
    NC_INVITE_ONLY_SIGNUPRemoved since version 0.99.0 and now it's recommended to use super admin settings menu. Allow users to signup only via invite URL, value should be any non-empty string.
    NUXT_PUBLIC_NC_BACKEND_URLCustom Backend URLhttp://localhost:8080 will be used
    NC_REQUEST_BODY_SIZERequest body size limit1048576
    NC_EXPORT_MAX_TIMEOUTAfter NC_EXPORT_MAX_TIMEOUT, CSV gets downloaded in batchesDefault value 5000(in millisecond) will be used
    NC_DISABLE_TELEDisable telemetry
    NC_DASHBOARD_URLCustom dashboard URL path/dashboard
    NC_GOOGLE_CLIENT_IDGoogle client ID to enable Google authentication
    NC_GOOGLE_CLIENT_SECRETGoogle client secret to enable Google authentication
    NC_MIGRATIONS_DISABLEDDisable NocoDB migration
    NC_MINIf set to any non-empty string the default splash screen(initial welcome animation) and matrix screensaver will disable
    NC_SENTRY_DSNFor Sentry monitoring
    NC_REDIS_URLCustom Redis URL. Example: redis://:authpassword@127.0.0.1:6380/4Meta data will be stored in memory
    NC_DISABLE_ERR_REPORTDisable error reporting
    NC_DISABLE_CACHETo be used only while debugging. On setting this to true - meta data be fetched from db instead of redis/cache.false
    AWS_ACCESS_KEY_IDFor Litestream - S3 access key idIf Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
    AWS_SECRET_ACCESS_KEYFor Litestream - S3 secret access keyIf Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
    AWS_BUCKETFor Litestream - S3 bucketIf Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
    AWS_BUCKET_PATHFor Litestream - S3 bucket path (like folder within S3 bucket)If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
    NC_SMTP_FROMFor SMTP plugin - Email sender address
    NC_SMTP_HOSTFor SMTP plugin - SMTP host value
    NC_SMTP_PORTFor SMTP plugin - SMTP port value
    NC_SMTP_USERNAMEFor SMTP plugin (Optional) - SMTP username value for authentication
    NC_SMTP_PASSWORDFor SMTP plugin (Optional) - SMTP password value for authentication
    NC_SMTP_SECUREFor SMTP plugin (Optional) - To enable secure set value as true any other value treated as false
    NC_SMTP_IGNORE_TLSFor SMTP plugin (Optional) - To ignore tls set value as true any other value treated as false. For more info visit https://nodemailer.com/smtp/
    NC_S3_BUCKET_NAMEFor S3 storage plugin - AWS S3 bucket name
    NC_S3_REGIONFor S3 storage plugin - AWS S3 region
    NC_S3_ACCESS_KEYFor S3 storage plugin - AWS access key credential for accessing resource
    NC_S3_ACCESS_SECRETFor S3 storage plugin - AWS access secret credential for accessing resource
    NC_ADMIN_EMAILFor updating/creating super admin with provided email and password
    NC_ATTACHMENT_FIELD_SIZEFor setting the attachment field size(in Bytes)Defaults to 20MB
    NC_ADMIN_PASSWORDFor updating/creating super admin with provided email and password. Your password should have at least 8 letters with one uppercase, one number and one special letter(Allowed special chars $&+,:;=?@#|'.^*()%!_-" )
    NODE_OPTIONSFor passing Node.js options to instance
    NC_MINIMAL_DBSCreate a new SQLite file for each project. All the db files are stored in nc_minimal_dbs folder in current working directory. (This option restricts project creation on external sources)
    NC_DISABLE_AUDITDisable Audit Logfalse
    NC_AUTOMATION_LOG_LEVELPossible Values: OFF, ERROR, ALL. See Webhooks for details.OFF
    NC_SECURE_ATTACHMENTSAllow accessing attachments only through presigned urls. To enable set value as true any other value treated as false. (⚠ this will make existing links inaccessible ⚠)false
    NC_ATTACHMENT_EXPIRE_SECONDSHow many seconds before expiring presigned attachment urls. (Attachments will expire in at least set seconds and at most 10mins after set time)7200 (2 hours)
    NC_ALLOW_LOCAL_HOOKSTo enable set value as true any other value treated as false. (⚠ this will allow webhooks to call local links which can raise security issues ⚠)false
    - +
    Version: Latest

    Environment variables

    For production use-cases, it is recommended to configure

    • NC_DB,
    • NC_AUTH_JWT_SECRET,
    • NC_PUBLIC_URL,
    • NC_REDIS_URL
    VariableCommentsIf absent
    NC_DBSee our example database URLs here.A local SQLite will be created in root folder if NC_DB is not provided
    NC_DB_JSONCan be used instead of NC_DB and value should be valid knex connection JSON
    NC_DB_JSON_FILECan be used instead of NC_DB and value should be a valid path to knex connection JSON
    DATABASE_URLCan be used instead of NC_DB and value should be in JDBC URL format
    DATABASE_URL_FILECan be used instead of DATABASE_URL and value should be a valid path to file containing JDBC URL format.
    NC_AUTH_JWT_SECRETJWT secret used for auth and storing other secretsA random secret will be generated
    PORTFor setting app running port8080
    DB_QUERY_LIMIT_DEFAULTPagination limit25
    DB_QUERY_LIMIT_MAXMaximum allowed pagination limit1000
    DB_QUERY_LIMIT_MINMinimum allowed pagination limit1
    NC_TOOL_DIRApp directory to keep metadata and app related filesDefaults to current working directory. In docker maps to /usr/app/data/ for mounting volume.
    NC_PUBLIC_URLUsed for sending Email invitationsBest guess from http request params
    NC_JWT_EXPIRES_INJWT token expiry time10h
    NC_CONNECT_TO_EXTERNAL_DB_DISABLEDDisable Project creation with external database
    NC_INVITE_ONLY_SIGNUPRemoved since version 0.99.0 and now it's recommended to use super admin settings menu. Allow users to signup only via invite URL, value should be any non-empty string.
    NUXT_PUBLIC_NC_BACKEND_URLCustom Backend URLhttp://localhost:8080 will be used
    NC_REQUEST_BODY_SIZERequest body size limit1048576
    NC_EXPORT_MAX_TIMEOUTAfter NC_EXPORT_MAX_TIMEOUT, CSV gets downloaded in batchesDefault value 5000(in millisecond) will be used
    NC_DISABLE_TELEDisable telemetry
    NC_DASHBOARD_URLCustom dashboard URL path/dashboard
    NC_GOOGLE_CLIENT_IDGoogle client ID to enable Google authentication
    NC_GOOGLE_CLIENT_SECRETGoogle client secret to enable Google authentication
    NC_MIGRATIONS_DISABLEDDisable NocoDB migration
    NC_MINIf set to any non-empty string the default splash screen(initial welcome animation) and matrix screensaver will disable
    NC_SENTRY_DSNFor Sentry monitoring
    NC_REDIS_URLCustom Redis URL. Example: redis://:authpassword@127.0.0.1:6380/4Meta data will be stored in memory
    NC_DISABLE_ERR_REPORTDisable error reporting
    NC_DISABLE_CACHETo be used only while debugging. On setting this to true - meta data be fetched from db instead of redis/cache.false
    AWS_ACCESS_KEY_IDFor Litestream - S3 access key idIf Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
    AWS_SECRET_ACCESS_KEYFor Litestream - S3 secret access keyIf Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
    AWS_BUCKETFor Litestream - S3 bucketIf Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
    AWS_BUCKET_PATHFor Litestream - S3 bucket path (like folder within S3 bucket)If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3
    NC_SMTP_FROMFor SMTP plugin - Email sender address
    NC_SMTP_HOSTFor SMTP plugin - SMTP host value
    NC_SMTP_PORTFor SMTP plugin - SMTP port value
    NC_SMTP_USERNAMEFor SMTP plugin (Optional) - SMTP username value for authentication
    NC_SMTP_PASSWORDFor SMTP plugin (Optional) - SMTP password value for authentication
    NC_SMTP_SECUREFor SMTP plugin (Optional) - To enable secure set value as true any other value treated as false
    NC_SMTP_IGNORE_TLSFor SMTP plugin (Optional) - To ignore tls set value as true any other value treated as false. For more info visit https://nodemailer.com/smtp/
    NC_S3_BUCKET_NAMEFor S3 storage plugin - AWS S3 bucket name
    NC_S3_REGIONFor S3 storage plugin - AWS S3 region
    NC_S3_ACCESS_KEYFor S3 storage plugin - AWS access key credential for accessing resource
    NC_S3_ACCESS_SECRETFor S3 storage plugin - AWS access secret credential for accessing resource
    NC_ADMIN_EMAILFor updating/creating super admin with provided email and password
    NC_ATTACHMENT_FIELD_SIZEFor setting the attachment field size(in Bytes)Defaults to 20MB
    NC_ADMIN_PASSWORDFor updating/creating super admin with provided email and password. Your password should have at least 8 letters with one uppercase, one number and one special letter(Allowed special chars $&+,:;=?@#|'.^*()%!_-" )
    NODE_OPTIONSFor passing Node.js options to instance
    NC_MINIMAL_DBSCreate a new SQLite file for each project. All the db files are stored in nc_minimal_dbs folder in current working directory. (This option restricts project creation on external sources)
    NC_DISABLE_AUDITDisable Audit Logfalse
    NC_AUTOMATION_LOG_LEVELPossible Values: OFF, ERROR, ALL. See Webhooks for details.OFF
    NC_SECURE_ATTACHMENTSAllow accessing attachments only through presigned urls. To enable set value as true any other value treated as false. (⚠ this will make existing links inaccessible ⚠)false
    NC_ATTACHMENT_EXPIRE_SECONDSHow many seconds before expiring presigned attachment urls. (Attachments will expire in at least set seconds and at most 10mins after set time)7200 (2 hours)
    NC_ALLOW_LOCAL_HOOKSTo enable set value as true any other value treated as false. (⚠ this will allow webhooks to call local links which can raise security issues ⚠)false
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/getting-started/self-hosted/installation/index.html b/packages/noco-docs/dist/getting-started/self-hosted/installation/index.html index 1fa5fa7822..20dc698506 100644 --- a/packages/noco-docs/dist/getting-started/self-hosted/installation/index.html +++ b/packages/noco-docs/dist/getting-started/self-hosted/installation/index.html @@ -4,17 +4,17 @@ Installation | NocoDB - +
    -
    Version: Latest

    Installation

    Simple installation - takes about three minutes!

    Prerequisites​

    • Docker or Node.js ( > v18.x ) +
      Version: Latest

      Installation

      Simple installation - takes about three minutes!

      Prerequisites​

      Quick try​

      Docker​

      If you are a Docker user, you may try this way!

      docker run -d --name nocodb \
      -v "$(pwd)"/nocodb:/usr/app/data/ \
      -p 8080:8080 \
      nocodb/nocodb:latest
      tip

      To persist data in docker you can mount volume at /usr/app/data/ since 0.10.6. In older version mount at /usr/src/app. Otherwise your data will be lost after recreating the container.

      tip

      If you plan to input some special characters, you may need to change the character set and collation yourself when creating the database. Please check out the examples for MySQL Docker.

      Docker Compose​

      We provide different docker-compose.yml files under this directory. Here are some examples.

      git clone https://github.com/nocodb/nocodb
      cd nocodb/docker-compose/mysql
      docker-compose up -d
      tip

      To persist data in docker you can mount volume at /usr/app/data/ since 0.10.6. In older version mount at /usr/src/app. If you plan to input some special characters, you may need to change the character set and collation yourself when creating the database. Please check out the examples for MySQL Docker Compose.

      NPX​

      You can run below command if you need an interactive configuration.

      npx create-nocodb-app

      Preview:​

      image

      Homebrew​

      brew tap nocodb/nocodb
      brew install nocodb
      nocodb

      Executables​

      You can download executables directly and run without any extra dependency. Use the right command based on your platform.

      curl http://get.nocodb.com/macos-x64 -o nocodb -L \
        && chmod +x nocodb \
        && ./nocodb

      Node Application​

      We provide a simple NodeJS Application for getting started.

      git clone https://github.com/nocodb/nocodb-seed
      cd nocodb-seed
      npm install
      npm start

      AWS ECS (Fargate)​

      Click to Expand

      Create ECS Cluster​

      aws ecs create-cluster \
      --cluster-name <YOUR_ECS_CLUSTER>

      Create Log group​

      aws logs create-log-group \
      --log-group-name /ecs/<YOUR_APP_NAME>/<YOUR_CONTAINER_NAME>

      Create ECS Task Definiton​

      Every time you create it, it will add a new version. If it is not existing, the version will be 1. 

      aws ecs register-task-definition \
      --cli-input-json "file://./<YOUR_TASK_DEF_NAME>.json"
      tip

      This json file defines the container specification. You can define secrets such as NC_DB and environment variables here.

      Here's the sample Task Definition

      {
        "family": "nocodb-sample-task-def",
        "networkMode": "awsvpc",
        "containerDefinitions": [{
          "name": "<YOUR_CONTAINER_NAME>",
          "image": "nocodb/nocodb:latest",
          "essential": true,
          "logConfiguration": {
            "logDriver": "awslogs",
            "options": {
              "awslogs-group": "/ecs/<YOUR_APP_NAME>/<YOUR_CONTAINER_NAME>",
              "awslogs-region": "<YOUR_AWS_REGION>",
              "awslogs-stream-prefix": "ecs"
            }
          },
          "secrets": [{
            "name": "<YOUR_SECRETS_NAME>",
            "valueFrom": "<YOUR_SECRET_ARN>"
          }],
          "environment": [{
            "name": "<YOUR_ENV_VARIABLE_NAME>",
            "value": "<YOUR_ENV_VARIABLE_VALUE>"
          }],
          "portMappings": [{
            "containerPort": 8080,
            "hostPort": 8080,
            "protocol": "tcp"
          }]
        }],
        "requiresCompatibilities": [
          "FARGATE"
        ],
        "cpu": "256",
        "memory": "512",
        "executionRoleArn": "<YOUR_ECS_EXECUTION_ROLE_ARN>",
        "taskRoleArn": "<YOUR_ECS_TASK_ROLE_ARN>"
      }

      Create ECS Service​

      aws ecs create-service \
      --cluster <YOUR_ECS_CLUSTER> \
      --service-name  <YOUR_SERVICE_NAME> \
      --task-definition <YOUR_TASK_DEF>:<YOUR_TASK_DEF_VERSION> \
      --desired-count <DESIRED_COUNT> \
      --launch-type "FARGATE" \
      --platform-version <VERSION> \
      --health-check-grace-period-seconds <GRACE_PERIOD_IN_SECOND> \
      --network-configuration "awsvpcConfiguration={subnets=["<YOUR_SUBSETS>"], securityGroups=["<YOUR_SECURITY_GROUPS>"], assignPublicIp=ENABLED}" \
      --load-balancer targetGroupArn=<TARGET_GROUP_ARN>,containerName=<CONTAINER_NAME>,containerPort=<YOUR_CONTAINER_PORT>
      tip

      If your service fails to start, you may check the logs in ECS console or in Cloudwatch. Generally it fails due to the connection between ECS container and NC_DB. Make sure the security groups have the correct inbound and outbound rules.

      GCP (Cloud Run)​

      Click to Expand

      Pull NocoDB Image on Cloud Shell​

      Since Cloud Run only supports images from Google Container Registry (GCR) or Artifact Registry, we need to pull NocoDB image, tag it and push it in GCP using Cloud Shell. Here are some sample commands which you can execute in Cloud Shell.

      # pull latest NocoDB image
      docker pull nocodb/nocodb:latest

      # tag the image
      docker tag nocodb/nocodb:latest gcr.io/<MY_PROJECT_ID>/nocodb/nocodb:latest

      # push the image to GCR
      docker push gcr.io/<MY_PROJECT_ID>/nocodb/nocodb:latest

      Deploy NocoDB on Cloud Run​

      gcloud run deploy --image=gcr.io/<MY_PROJECT_ID>/nocodb/nocodb:latest \
                        --region=us-central1 \
                        --allow-unauthenticated \
                        --platform=managed

      DigitalOcean (App)​

      Click to Expand

      Create Apps​

      On Home page, Click on Create icon & Select Apps (Deploy your code).

      Screenshot 2022-02-19 at 12 17 43 PM

      Choose Source: Docker Hub​

      Screenshot 2022-02-19 at 12 22 01 PM

      Choose Source: Repository​

      Configure Source Repository as nocodb/nocodb. Optionally you can pick release tag if you are interested in specific NocoDB version.

      Screenshot 2022-02-19 at 12 23 11 PM

      [Optional] Additional Configurations​

      Screenshot 2022-02-19 at 12 24 44 PM

      Name your web service​

      Pick a name for your NocoDB application. This name will become part of URL subsequently Pick nearest Region for cloud hosting Screenshot 2022-02-19 at 12 28 11 PM

      Finalize and Launch​

      Cloudron​

      Click to Expand

      Log into Cloudron and select App Store

      image

      Search NocoDB​

      image

      Click Install​

      image

      Configure NocoDB​

      image

      Go to My App and Launch NocoDB​

      image

      CapRover​

      Click to Expand

      Login and Click One-Click Apps / Databases​

      image

      Search NocoDB​

      image

      Configure NocoDB and Deploy​

      image

      Railway​

      Click to Expand

      Go to Templates, Search NocoDB and click Deploy

      image

      Configure NocoDB and Deploy​

      image

      FreeBSD / FreeNAS / TrueNAS Jail​

      See here provided by C. R. Zamana.

      Sample Demos​

      Code Sandbox​

      Docker deploying with one command​

      Using NPX​

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/getting-started/self-hosted/upgrading/index.html b/packages/noco-docs/dist/getting-started/self-hosted/upgrading/index.html index 42fb518e24..25f7778af4 100644 --- a/packages/noco-docs/dist/getting-started/self-hosted/upgrading/index.html +++ b/packages/noco-docs/dist/getting-started/self-hosted/upgrading/index.html @@ -4,13 +4,13 @@ Upgrading | NocoDB - +
    -
    Version: Latest

    Upgrading

    By default, if NC_DB is not specified upon installation, then SQLite will be used to store metadata. We suggest users to separate the metadata and user data in different databases as pictured in our architecture.

    Docker​

    Find, Stop & Delete NocoDB Docker Container​

    # find NocoDB container ID
    docker ps
    # stop NocoDB container
    docker stop <YOUR_CONTAINER_ID>
    # delete NocoDB container
    docker rm <YOUR_CONTAINER_ID>

    Note: Deleting your docker container without setting NC_DB or mounting to a persistent volume for a default SQLite database will result in losing your data. See examples below.

    Find & Remove NocoDB Docker Image​

    # find NocoDB image
    docker images
    # delete NocoDB image
    docker rmi <YOUR_IMAGE_ID>

    Pull the latest NocoDB image with same environment variables​

    docker run -d -p 8080:8080 \
        -e NC_DB="<YOUR_NC_DB_URL>" \
        -e NC_AUTH_JWT_SECRET="<YOUR_NC_AUTH_JWT_SECRET_IF_GIVEN>" \
        nocodb/nocodb:latest

    Updating NocoDB docker container is similar to updating any other docker containers.

    Example: Docker Upgrade​

    # Previous docker run
    #
    terminal % docker run -d --name myNocoDB \
    -v "$(pwd)"/nocodb:/usr/app/data/ \
    -p 8080:8080 \
    -e NC_DB="pg://host.docker.internal:5432?u=postgres&p=password&d=d1" \
    -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
    nocodb/nocodb:0.111.0
    Unable to find image 'nocodb/nocodb:0.111.0' locally
    0.111.0: Pulling from nocodb/nocodb
    ad3fa0ea069c: Pull complete 
    e43b9156e769: Pull complete 
    c1bee0da1504: Pull complete 
    adf78ab024d9: Pull complete 
    cd8000d2c16a: Pull complete 
    Digest: sha256:93b6e1ba2c0b90a26b205f9c7d44053aa6d8fa037eff9eb4155ca017f6c9bed4
    Status: Downloaded newer image for nocodb/nocodb:0.111.0
    afdc8edd1005c93e1df8f90d02e46430ea7b5c5610a2bf9ba105238d6c4d927b


    # Find, stop and delete NocoDB docker container
    #
    terminal % docker ps
    CONTAINER ID   IMAGE                   COMMAND                  CREATED          STATUS                 PORTS                    NAMES
    afdc8edd1005   nocodb/nocodb:0.111.0   "/usr/bin/dumb-init …"   18 seconds ago   Up 18 seconds          0.0.0.0:8080->8080/tcp   myNocoDB
    0202041b3607   postgres:14.7           "docker-entrypoint.s…"   2 days ago       Up 8 hours (healthy)   0.0.0.0:5432->5432/tcp   scripts_pg147_1

    terminal % docker stop afdc8edd1005
    afdc8edd1005

    terminal % docker rm afdc8edd1005
    afdc8edd1005


    # Find and remove NocoDB docker image
    #
    terminal % docker images
    REPOSITORY      TAG       IMAGE ID       CREATED        SIZE
    nocodb/nocodb   0.111.0   34609411e87c   5 weeks ago    132MB
    mysql           8.0       6a0560a40914   7 weeks ago    599MB
    postgres        14.7      2075a95c7b3b   4 months ago   358MB

    terminal % docker rmi 34609411e87c
    Untagged: nocodb/nocodb:0.111.0
    Untagged: nocodb/nocodb@sha256:93b6e1ba2c0b90a26b205f9c7d44053aa6d8fa037eff9eb4155ca017f6c9bed4
    Deleted: sha256:3bfxxxx38e682742cbxxxx535b3503af45e931fb9bd15f46eca7d33cf4c54d72
    Deleted: sha256:952152b5da42ae057c6688a04xxxx72e1a2f91825956f5c7e35f91d5b285d4d8
    Deleted: sha256:3155197577xxxx673675ed1bce761714a24d7803f70a905740f7d4c248cxxxxx


    # Pull & run the latest NocoDB image with same environment variables as before
    #
    terminal % docker run -d --name myNocoDB \
    -v "$(pwd)"/nocodb:/usr/app/data/ \
    -p 8080:8080 \
    -e NC_DB="pg://host.docker.internal:5432?u=postgres&p=password&d=d1" \
    -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
    nocodb/nocodb:latest
    Unable to find image 'nocodb/nocodb:latest' locally
    latest: Pulling from nocodb/nocodb
    ad3fa0ea069c: Pull complete 
    e43b9156e769: Pull complete 
    c1bee0da1504: Pull complete 
    adf78ab024d9: Pull complete 
    28ce4fc94e48: Pull complete 
    Digest: sha256:5c6df5ff0eb1278e1dbfe684af630a743ca73dfec8c30cab3bae9c1d0d640287
    Status: Downloaded newer image for nocodb/nocodb:latest
    ae793a04b75f2f3ee78abbaef09891396a884ec83320151a266326195649a058


    Node​

    Updating docker container is similar to updating a npm package.

    From your root folder

    Uninstall NocoDB package​

    npm uninstall nocodb

    Install NocoDB package​

    npm install --save nocodb

    Homebrew​

    Run following commands to upgrade Homebrew Nocodb version.

    # Update the local homebrew formulas
    brew update
    # Upgrade nocodb package
    brew upgrade nocodb
    - +
    Version: Latest

    Upgrading

    By default, if NC_DB is not specified upon installation, then SQLite will be used to store metadata. We suggest users to separate the metadata and user data in different databases as pictured in our architecture.

    Docker​

    Find, Stop & Delete NocoDB Docker Container​

    # find NocoDB container ID
    docker ps
    # stop NocoDB container
    docker stop <YOUR_CONTAINER_ID>
    # delete NocoDB container
    docker rm <YOUR_CONTAINER_ID>

    Note: Deleting your docker container without setting NC_DB or mounting to a persistent volume for a default SQLite database will result in losing your data. See examples below.

    Find & Remove NocoDB Docker Image​

    # find NocoDB image
    docker images
    # delete NocoDB image
    docker rmi <YOUR_IMAGE_ID>

    Pull the latest NocoDB image with same environment variables​

    docker run -d -p 8080:8080 \
        -e NC_DB="<YOUR_NC_DB_URL>" \
        -e NC_AUTH_JWT_SECRET="<YOUR_NC_AUTH_JWT_SECRET_IF_GIVEN>" \
        nocodb/nocodb:latest

    Updating NocoDB docker container is similar to updating any other docker containers.

    Example: Docker Upgrade​

    # Previous docker run
    #
    terminal % docker run -d --name myNocoDB \
    -v "$(pwd)"/nocodb:/usr/app/data/ \
    -p 8080:8080 \
    -e NC_DB="pg://host.docker.internal:5432?u=postgres&p=password&d=d1" \
    -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
    nocodb/nocodb:0.111.0
    Unable to find image 'nocodb/nocodb:0.111.0' locally
    0.111.0: Pulling from nocodb/nocodb
    ad3fa0ea069c: Pull complete 
    e43b9156e769: Pull complete 
    c1bee0da1504: Pull complete 
    adf78ab024d9: Pull complete 
    cd8000d2c16a: Pull complete 
    Digest: sha256:93b6e1ba2c0b90a26b205f9c7d44053aa6d8fa037eff9eb4155ca017f6c9bed4
    Status: Downloaded newer image for nocodb/nocodb:0.111.0
    afdc8edd1005c93e1df8f90d02e46430ea7b5c5610a2bf9ba105238d6c4d927b


    # Find, stop and delete NocoDB docker container
    #
    terminal % docker ps
    CONTAINER ID   IMAGE                   COMMAND                  CREATED          STATUS                 PORTS                    NAMES
    afdc8edd1005   nocodb/nocodb:0.111.0   "/usr/bin/dumb-init …"   18 seconds ago   Up 18 seconds          0.0.0.0:8080->8080/tcp   myNocoDB
    0202041b3607   postgres:14.7           "docker-entrypoint.s…"   2 days ago       Up 8 hours (healthy)   0.0.0.0:5432->5432/tcp   scripts_pg147_1

    terminal % docker stop afdc8edd1005
    afdc8edd1005

    terminal % docker rm afdc8edd1005
    afdc8edd1005


    # Find and remove NocoDB docker image
    #
    terminal % docker images
    REPOSITORY      TAG       IMAGE ID       CREATED        SIZE
    nocodb/nocodb   0.111.0   34609411e87c   5 weeks ago    132MB
    mysql           8.0       6a0560a40914   7 weeks ago    599MB
    postgres        14.7      2075a95c7b3b   4 months ago   358MB

    terminal % docker rmi 34609411e87c
    Untagged: nocodb/nocodb:0.111.0
    Untagged: nocodb/nocodb@sha256:93b6e1ba2c0b90a26b205f9c7d44053aa6d8fa037eff9eb4155ca017f6c9bed4
    Deleted: sha256:3bfxxxx38e682742cbxxxx535b3503af45e931fb9bd15f46eca7d33cf4c54d72
    Deleted: sha256:952152b5da42ae057c6688a04xxxx72e1a2f91825956f5c7e35f91d5b285d4d8
    Deleted: sha256:3155197577xxxx673675ed1bce761714a24d7803f70a905740f7d4c248cxxxxx


    # Pull & run the latest NocoDB image with same environment variables as before
    #
    terminal % docker run -d --name myNocoDB \
    -v "$(pwd)"/nocodb:/usr/app/data/ \
    -p 8080:8080 \
    -e NC_DB="pg://host.docker.internal:5432?u=postgres&p=password&d=d1" \
    -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
    nocodb/nocodb:latest
    Unable to find image 'nocodb/nocodb:latest' locally
    latest: Pulling from nocodb/nocodb
    ad3fa0ea069c: Pull complete 
    e43b9156e769: Pull complete 
    c1bee0da1504: Pull complete 
    adf78ab024d9: Pull complete 
    28ce4fc94e48: Pull complete 
    Digest: sha256:5c6df5ff0eb1278e1dbfe684af630a743ca73dfec8c30cab3bae9c1d0d640287
    Status: Downloaded newer image for nocodb/nocodb:latest
    ae793a04b75f2f3ee78abbaef09891396a884ec83320151a266326195649a058


    Node​

    Updating docker container is similar to updating a npm package.

    From your root folder

    Uninstall NocoDB package​

    npm uninstall nocodb

    Install NocoDB package​

    npm install --save nocodb

    Homebrew​

    Run following commands to upgrade Homebrew Nocodb version.

    # Update the local homebrew formulas
    brew update
    # Upgrade nocodb package
    brew upgrade nocodb
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/getting-started/terminologies/index.html b/packages/noco-docs/dist/getting-started/terminologies/index.html index dc593dcd26..4e871f74e4 100644 --- a/packages/noco-docs/dist/getting-started/terminologies/index.html +++ b/packages/noco-docs/dist/getting-started/terminologies/index.html @@ -4,13 +4,13 @@ NocoDB terminologies | NocoDB - +
    -
    Version: Latest

    NocoDB terminologies

    To maximize your use of NocoDB, it's beneficial to become familiar with some common terms.

    Within this section, we've provided straightforward explanations for keywords and phrases that are relevant to NocoDB's functionality and capabilities. This resource is designed to assist you in gaining a deeper understanding of NocoDB as you embark on the process of setting up workspaces, bases, tables, and various other elements within the platform.

    Layout​

    The layout below shows the main parts of NocoDB's user interface.

    image

    1. Sidebar: This component provides quick access to workspaces, bases, tables, and views, facilitating easy navigation within NocoDB.

    2. Navbar: In the Navbar, you'll find essential tools like the Switcher, allowing users to switch between data mode and details mode, and the Share button for collaborative workspace and view sharing.

    3. Toolbar: The Toolbar equips users with various tools to manage records within tables and views effectively. It includes features for sorting, filtering, and editing data, enhancing your control over information.

    4. View Area: The central workspace where data can be viewed in multiple formats - Grid, Gallery, Kanban or Form.

    5. Footbar: A pagination bar for navigating between paginated records.

    Terminologies​

    TermDescription
    BaseA base is a collection of one or more tables, often related and linked to one another. Alternative term Project
    Base OwnerMember who had created base. There can be only one owner for a base & ownership is non-transferable
    Base memberBase member with specific access permissions. Alternative term Member User
    CellA cell represents the space created where a column and a row intersect within a grid-like structure. It serves as the fundamental unit for storing data
    FieldA field or column in a table is a container for values that share the same data type. Alternative term Column
    ModalIn the context of user interfaces, a modal is a type of dialog or overlay that appears on top of the main content or interface and requires user interaction before the user can proceed. Modals are often used to gather user input, display alerts, or confirm actions. They typically "block" the rest of the interface until the user dismisses them, making them a focused and attention-grabbing element
    RecordA record represents a row in a table. Alternative term Row
    TableA base is housed in tables, where data is logically arranged into rows and columns. A base can have multiple tables. Alternative term Model
    TermDescription
    ViewA view defines how data within a table is presented and interacted with. Default view type is the grid view; other supported view types include form, gallery, and kanban views.
    WebhookA webhook is a mechanism that allows one system to send real-time data to another system or application. It enables automated notifications and data synchronization between different services or platforms by triggering predefined actions or events in response to specific events or updates in the source system.
    Workspace OwnerMember who had created workspace. There can be only one owner for a workspace & ownership is non-transferable
    Workspace memberWorkspace member with specific access permissions. Alternative term Member User
    WorkspaceA workspace is a collection of one or more bases. It offers collaborative access to bases by enabling you to bring together interconnected tables, views, and various elements into a unified and organized entity
    - +
    Version: Latest

    NocoDB terminologies

    To maximize your use of NocoDB, it's beneficial to become familiar with some common terms.

    Within this section, we've provided straightforward explanations for keywords and phrases that are relevant to NocoDB's functionality and capabilities. This resource is designed to assist you in gaining a deeper understanding of NocoDB as you embark on the process of setting up workspaces, bases, tables, and various other elements within the platform.

    Layout​

    The layout below shows the main parts of NocoDB's user interface.

    image

    1. Sidebar: This component provides quick access to workspaces, bases, tables, and views, facilitating easy navigation within NocoDB.

    2. Navbar: In the Navbar, you'll find essential tools like the Switcher, allowing users to switch between data mode and details mode, and the Share button for collaborative workspace and view sharing.

    3. Toolbar: The Toolbar equips users with various tools to manage records within tables and views effectively. It includes features for sorting, filtering, and editing data, enhancing your control over information.

    4. View Area: The central workspace where data can be viewed in multiple formats - Grid, Gallery, Kanban or Form.

    5. Footbar: A pagination bar for navigating between paginated records.

    Terminologies​

    TermDescription
    BaseA base is a collection of one or more tables, often related and linked to one another. Alternative term Project
    Base OwnerMember who had created base. There can be only one owner for a base & ownership is non-transferable
    Base memberBase member with specific access permissions. Alternative term Member User
    CellA cell represents the space created where a column and a row intersect within a grid-like structure. It serves as the fundamental unit for storing data
    FieldA field or column in a table is a container for values that share the same data type. Alternative term Column
    ModalIn the context of user interfaces, a modal is a type of dialog or overlay that appears on top of the main content or interface and requires user interaction before the user can proceed. Modals are often used to gather user input, display alerts, or confirm actions. They typically "block" the rest of the interface until the user dismisses them, making them a focused and attention-grabbing element
    RecordA record represents a row in a table. Alternative term Row
    TableA base is housed in tables, where data is logically arranged into rows and columns. A base can have multiple tables. Alternative term Model
    TermDescription
    ViewA view defines how data within a table is presented and interacted with. Default view type is the grid view; other supported view types include form, gallery, and kanban views.
    WebhookA webhook is a mechanism that allows one system to send real-time data to another system or application. It enables automated notifications and data synchronization between different services or platforms by triggering predefined actions or events in response to specific events or updates in the source system.
    Workspace OwnerMember who had created workspace. There can be only one owner for a workspace & ownership is non-transferable
    Workspace memberWorkspace member with specific access permissions. Alternative term Member User
    WorkspaceA workspace is a collection of one or more bases. It offers collaborative access to bases by enabling you to bring together interconnected tables, views, and various elements into a unified and organized entity
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/index.html b/packages/noco-docs/dist/index.html index 6f392ea3ec..999a697e8e 100644 --- a/packages/noco-docs/dist/index.html +++ b/packages/noco-docs/dist/index.html @@ -4,13 +4,13 @@ Welcome | NocoDB - +
    -
    Version: Latest

    Welcome

    image

    NocoDB is a no-code database platform that allows teams to collaborate and build applications with ease of a familiar and intuitive spreadsheet interface. This allows even non-developers or business users to become software creators.

    NocoDB works by connecting to any relational database and transforming them into a smart spreadsheet interface! This allows you to build no-code applications collaboratively with teams. NocoDB currently works with MySQL, PostgreSQL & SQLite (only in Open Source) databases.

    Also, NocoDB's app store allows you to build business workflows on views with combination of Slack, Microsoft Teams, Discord, Twilio, Whatsapp, Email & any 3rd party APIs too. Plus NocoDB provides programmatic access to APIs so that you can build integrations with Zapier / Integromat and custom applications too.

    Features​

    Rich Spreadsheet Interface​

    • ⚡  Basic Operations: Create, Read, Update and Delete on Tables, Fields, and Records
    • ⚡  Fields Operations: Sort, Filter, Hide / Un-hide Fields
    • ⚡  Multiple Views Types: Grid (By default), Gallery, Form View and Kanban View
    • ⚡  View Permissions Types: Collaborative Views & Locked Views
    • ⚡  Share Bases / Views: either Public or Private (with Password Protected)
    • ⚡  Variant Cell Types: ID, Links, Lookup, Rollup, SingleLineText, Attachment, Currency, Formula and etc
    • ⚡  Access Control with Roles : Fine-grained Access Control at different levels
    • ⚡  and more ...

    App Store for Workflow Automations​

    We provide different integrations in three main categories. See App Store for details.

    • ⚡  Chat : Slack, Discord, Mattermost, and etc
    • ⚡  Email : AWS SES, SMTP, MailerSend, and etc
    • ⚡  Storage : AWS S3, Google Cloud Storage, Minio, and etc

    Programmatic Access​

    We provide the following ways to let users invoke actions in a programmatic way. You can use a token (either JWT or Social Auth) to sign your requests for authorization to NocoDB.

    • ⚡  REST APIs
    • ⚡  NocoDB SDK
    • ⚡  SQL Access : Run SQL queries on your data source from NocoDB UI itself (Coming soon!)

    Sync Schema​

    We allow you to sync schema changes if you have made changes outside NocoDB GUI. However, it has to be noted then you will have to bring your own schema migrations for moving from environment to others. See Sync Schema for details.

    Audit​

    We are keeping all the user operation logs under one place. See Audit for details.

    Why are we building this?​

    Most internet businesses equip themselves with either spreadsheet or a database to solve their business needs. Spreadsheets are used by a Billion+ humans collaboratively every single day. However, we are way off working at similar speeds on databases which are way more powerful tools when it comes to computing. Attempts to solve this with SaaS offerings has meant horrible access controls, vendor lockin, data lockin, abrupt price changes & most importantly a glass ceiling on what's possible in the future.

    Our Mission​

    Our mission is to provide the most powerful no-code interface for databases which is Open Source to every single internet business in the world. This would not only democratise access to a powerful computing tool but also bring forth a billion+ people who will have radical tinkering-and-building abilities on internet.

    How can I contribute to NocoDB's development ?​

    Please refer to here for the contribution guidelines.

    Where can I join the NocoDB community?​

    Follow us for daily updates, content, and other activities with our community:

    - +
    Version: Latest

    Welcome

    image

    NocoDB is a no-code database platform that allows teams to collaborate and build applications with ease of a familiar and intuitive spreadsheet interface. This allows even non-developers or business users to become software creators.

    NocoDB works by connecting to any relational database and transforming them into a smart spreadsheet interface! This allows you to build no-code applications collaboratively with teams. NocoDB currently works with MySQL, PostgreSQL & SQLite (only in Open Source) databases.

    Also, NocoDB's app store allows you to build business workflows on views with combination of Slack, Microsoft Teams, Discord, Twilio, Whatsapp, Email & any 3rd party APIs too. Plus NocoDB provides programmatic access to APIs so that you can build integrations with Zapier / Integromat and custom applications too.

    Features​

    Rich Spreadsheet Interface​

    • ⚡  Basic Operations: Create, Read, Update and Delete on Tables, Fields, and Records
    • ⚡  Fields Operations: Sort, Filter, Hide / Un-hide Fields
    • ⚡  Multiple Views Types: Grid (By default), Gallery, Form View and Kanban View
    • ⚡  View Permissions Types: Collaborative Views & Locked Views
    • ⚡  Share Bases / Views: either Public or Private (with Password Protected)
    • ⚡  Variant Cell Types: ID, Links, Lookup, Rollup, SingleLineText, Attachment, Currency, Formula and etc
    • ⚡  Access Control with Roles : Fine-grained Access Control at different levels
    • ⚡  and more ...

    App Store for Workflow Automations​

    We provide different integrations in three main categories. See App Store for details.

    • ⚡  Chat : Slack, Discord, Mattermost, and etc
    • ⚡  Email : AWS SES, SMTP, MailerSend, and etc
    • ⚡  Storage : AWS S3, Google Cloud Storage, Minio, and etc

    Programmatic Access​

    We provide the following ways to let users invoke actions in a programmatic way. You can use a token (either JWT or Social Auth) to sign your requests for authorization to NocoDB.

    • ⚡  REST APIs
    • ⚡  NocoDB SDK
    • ⚡  SQL Access : Run SQL queries on your data source from NocoDB UI itself (Coming soon!)

    Sync Schema​

    We allow you to sync schema changes if you have made changes outside NocoDB GUI. However, it has to be noted then you will have to bring your own schema migrations for moving from environment to others. See Sync Schema for details.

    Audit​

    We are keeping all the user operation logs under one place. See Audit for details.

    Why are we building this?​

    Most internet businesses equip themselves with either spreadsheet or a database to solve their business needs. Spreadsheets are used by a Billion+ humans collaboratively every single day. However, we are way off working at similar speeds on databases which are way more powerful tools when it comes to computing. Attempts to solve this with SaaS offerings has meant horrible access controls, vendor lockin, data lockin, abrupt price changes & most importantly a glass ceiling on what's possible in the future.

    Our Mission​

    Our mission is to provide the most powerful no-code interface for databases which is Open Source to every single internet business in the world. This would not only democratise access to a powerful computing tool but also bring forth a billion+ people who will have radical tinkering-and-building abilities on internet.

    How can I contribute to NocoDB's development ?​

    Please refer to here for the contribution guidelines.

    Where can I join the NocoDB community?​

    Follow us for daily updates, content, and other activities with our community:

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/records/actions-on-record/index.html b/packages/noco-docs/dist/records/actions-on-record/index.html index 8da2a834d0..bfb8de59b0 100644 --- a/packages/noco-docs/dist/records/actions-on-record/index.html +++ b/packages/noco-docs/dist/records/actions-on-record/index.html @@ -4,15 +4,15 @@ Actions on record | NocoDB - +
    -
    Version: Latest

    Actions on record

    Keyboard navigation within Grid view​

    A selected cell can be in one of the following states:

    1. Select state : A single click on the cell selects the cell. When in this state, arrow keys can be used to navigate to adjacent cells.
    2. Edit state : A double click on the cell puts the cell in edit state. Cursor can be moved within the cell using arrow keys.
    note
    • Double-click on a cell to put it in edit state directly.
    • From Select state, press Enter key to enter edit state.
    • Press Esc key to exit edit state.
    • From Edit state, press Enter key to save the changes.

    Edit state for some cells will be a picker. For example, a cell with Single Select field type will have a picker with options to choose from. In such cases, arrow keys can be used to navigate between options.

    Keyboard shortcuts for cell navigation​

    KeyBehaviour
    ⌘ ↑Jump to first record in this field (in same page)
    ⌘ ↓Jump to last record in this field (in same page)
    ⌘ CCopy cell contents to clipboard
    ⌘ VPaste clipboard contents to cell
    EnterSwitch cell in focus to EDIT mode; opens modal/picker if cell is associated with one
    EscExit cell EDIT mode
    DeleteClear cell
    SpaceExpand current record
    ← → ↑ ↓General cell navigation : left, right, top, bottom
    TabMove to next cell horizontally; if on last cell, move to beginning of next record

    Update Record​

    You can start editing by any of the following methods

    • Double-click on cell to edit
    • Click on cell and start typing (this way it will clear the previous content)
    • Click on cell and press enter to start editing

    And it will automatically save on blur event or if inactive.

    Bulk Update Records​

    You can bulk update records by

    1. Selecting multiple records that you wish to update together and then
    2. Right-click on the index field area (first column on the grid view) and then select Bulk Update records option from the context menu. This will open Bulk update modal. +
      Version: Latest

      Actions on record

      Keyboard navigation within Grid view​

      A selected cell can be in one of the following states:

      1. Select state : A single click on the cell selects the cell. When in this state, arrow keys can be used to navigate to adjacent cells.
      2. Edit state : A double click on the cell puts the cell in edit state. Cursor can be moved within the cell using arrow keys.
      note
      • Double-click on a cell to put it in edit state directly.
      • From Select state, press Enter key to enter edit state.
      • Press Esc key to exit edit state.
      • From Edit state, press Enter key to save the changes.

      Edit state for some cells will be a picker. For example, a cell with Single Select field type will have a picker with options to choose from. In such cases, arrow keys can be used to navigate between options.

      Keyboard shortcuts for cell navigation​

      KeyBehaviour
      ⌘ ↑Jump to first record in this field (in same page)
      ⌘ ↓Jump to last record in this field (in same page)
      ⌘ CCopy cell contents to clipboard
      ⌘ VPaste clipboard contents to cell
      EnterSwitch cell in focus to EDIT mode; opens modal/picker if cell is associated with one
      EscExit cell EDIT mode
      DeleteClear cell
      SpaceExpand current record
      ← → ↑ ↓General cell navigation : left, right, top, bottom
      TabMove to next cell horizontally; if on last cell, move to beginning of next record

      Update Record​

      You can start editing by any of the following methods

      • Double-click on cell to edit
      • Click on cell and start typing (this way it will clear the previous content)
      • Click on cell and press enter to start editing

      And it will automatically save on blur event or if inactive.

      Bulk Update Records​

      You can bulk update records by

      1. Selecting multiple records that you wish to update together and then
      2. Right-click on the index field area (first column on the grid view) and then select Bulk Update records option from the context menu. This will open Bulk update modal. On the bulk update modal,
      3. Fields area : Select the fields that you want to update.
      4. Selected fields area : Enter the new value for the selected fields.
      5. Click on the Bulk Update all button
      6. A confirmation dialog will be displayed. Click on Confirm to update the records.
      danger

      This operation cannot be undone.

      Bulk Update

      Bulk Update

      Bulk Update

      info

      You can drag drop required fields from the Fields area to the Selected fields area & vice versa.
      You can update multiple fields at a time.

      Delete Record (Single)​

      Right-click on record and then from the cell context menu, select Delete Record option.

      delete row -1

      Delete Record (Bulk)​

      Select multiple records by using the checkbox in first column and then Delete Selected Records options from the right click context menu.

      delete row 2

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/records/create-record/index.html b/packages/noco-docs/dist/records/create-record/index.html index 8f4bffbdf1..b308b4bdbb 100644 --- a/packages/noco-docs/dist/records/create-record/index.html +++ b/packages/noco-docs/dist/records/create-record/index.html @@ -4,13 +4,13 @@ Create record | NocoDB - +
    -
    Version: Latest

    Create record

    A new record can be added by using the New Record button in the bottom left corner of the grid view. Default behaviour of this button is to add a new empty record at the end of the grid view. Fields for a record can be populated by clicking on the cell and entering the value.

    info
    • An empty record can also be added by using + icon in the last record of the grid view.
    • When on last record, Enter key can be used to add a new empty record to the grid view.

    image

    NocoDB also provides convenience of a form to populate fields in a record. To add a new record using a form,

    1. Click on the up-arrow in New Record button; this expands options for adding a new record.
    2. Select New Record - Form option. This will reconfigure default behaviour of New Record button to add a new record using a form.

    image

    info

    To revert back to default behaviour of New Record button, click on the up-arrow in New Record button and select New Record - Grid option.

    - +
    Version: Latest

    Create record

    A new record can be added by using the New Record button in the bottom left corner of the grid view. Default behaviour of this button is to add a new empty record at the end of the grid view. Fields for a record can be populated by clicking on the cell and entering the value.

    info
    • An empty record can also be added by using + icon in the last record of the grid view.
    • When on last record, Enter key can be used to add a new empty record to the grid view.

    image

    NocoDB also provides convenience of a form to populate fields in a record. To add a new record using a form,

    1. Click on the up-arrow in New Record button; this expands options for adding a new record.
    2. Select New Record - Form option. This will reconfigure default behaviour of New Record button to add a new record using a form.

    image

    info

    To revert back to default behaviour of New Record button, click on the up-arrow in New Record button and select New Record - Grid option.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/records/expand-record/index.html b/packages/noco-docs/dist/records/expand-record/index.html index 4bba4fccfc..cca3d61530 100644 --- a/packages/noco-docs/dist/records/expand-record/index.html +++ b/packages/noco-docs/dist/records/expand-record/index.html @@ -4,14 +4,14 @@ Expanded record | NocoDB - +
    -
    Version: Latest

    Expanded record

    Overview​

    Expanded record allows you to edit a record data using a form layout. Apart from record information, it also consists of the activity feed such as user comments or record revision history (audit).

    expanded record

    Expanding a Record​

    To expand a record in a grid view, click on expand icon that appears on the first column (index column) on hover over a record.

    expand record icon

    tip

    Shortcut : Use space bar on any cell to expand associated record.

    Edit record​

    Expanded form displays all the fields of a record enabled for display in a form layout.

    1. You can edit the record data by clicking on the field and entering the value.
    2. Show hidden fields: Click on Show hidden fields button to display all the fields of a record.
    3. Click on Save button to save the changes. Close the expanded form by clicking on X button in the top right corner of the form to discard the changes.
    4. Navigate to next/previous record using Next/Previous button in the top left corner of the form.
    info

    Any changes made to the links field (link/unlink) will be saved automatically.

    edit record

    Record Audit​

    In an expanded form,

    1. Click on Audit tab
    2. A list of all the changes made to the record will be displayed
    info
    • You can only view the audit log. You cannot edit or delete the audit log.
    • Audit log is only available in Self-hosted version currently

    expand record activity feed

    Record Comment​

    Add Comment​

    In an expanded form,

    1. Click on Comments tab
    2. A list of all the comments made to the record will be displayed
    3. Click on input box at the bottom to add a new comment, and press Enter to save

    expand record comment

    Edit Comment​

    In comments list of an expanded form,

    1. Click on Edit icon on the right side of the comment
    2. Edit the comment and
    3. Click on Save icon OR Press Enter to save the changes

    expand record comment

    expand record comment

    expand record comment

    note

    You can only edit your own comments. You cannot delete a comment, but can edit it to remove the content. +

    Version: Latest

    Expanded record

    Overview​

    Expanded record allows you to edit a record data using a form layout. Apart from record information, it also consists of the activity feed such as user comments or record revision history (audit).

    expanded record

    Expanding a Record​

    To expand a record in a grid view, click on expand icon that appears on the first column (index column) on hover over a record.

    expand record icon

    tip

    Shortcut : Use space bar on any cell to expand associated record.

    Edit record​

    Expanded form displays all the fields of a record enabled for display in a form layout.

    1. You can edit the record data by clicking on the field and entering the value.
    2. Show hidden fields: Click on Show hidden fields button to display all the fields of a record.
    3. Click on Save button to save the changes. Close the expanded form by clicking on X button in the top right corner of the form to discard the changes.
    4. Navigate to next/previous record using Next/Previous button in the top left corner of the form.
    info

    Any changes made to the links field (link/unlink) will be saved automatically.

    edit record

    Record Audit​

    In an expanded form,

    1. Click on Audit tab
    2. A list of all the changes made to the record will be displayed
    info
    • You can only view the audit log. You cannot edit or delete the audit log.
    • Audit log is only available in Self-hosted version currently

    expand record activity feed

    Record Comment​

    Add Comment​

    In an expanded form,

    1. Click on Comments tab
    2. A list of all the comments made to the record will be displayed
    3. Click on input box at the bottom to add a new comment, and press Enter to save

    expand record comment

    Edit Comment​

    In comments list of an expanded form,

    1. Click on Edit icon on the right side of the comment
    2. Edit the comment and
    3. Click on Save icon OR Press Enter to save the changes

    expand record comment

    expand record comment

    expand record comment

    note

    You can only edit your own comments. You cannot delete a comment, but can edit it to remove the content. Changes to comments are also recorded in the audit log.

    Record Actions​

    Copy Record URL​

    In an expanded form, click Copy Record URL to share the record form to other authorized users.

    Duplicate record​

    Using context menu (...) in the top right corner of the expanded form, you can duplicate the record. Duplicated record will not be saved by default. You can edit the record and save it.

    delete record

    Delete record​

    Using context menu (...) in the top right corner of the expanded form, you can delete the record.

    delete record

    On the confirmation dialog, click on Delete button to delete the record.

    delete record

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/records/records-overview/index.html b/packages/noco-docs/dist/records/records-overview/index.html index 450d84af27..3854785e41 100644 --- a/packages/noco-docs/dist/records/records-overview/index.html +++ b/packages/noco-docs/dist/records/records-overview/index.html @@ -4,13 +4,13 @@ Records overview | NocoDB - +
    -
    Version: Latest

    Records overview

    Records in NocoDB are fundamental components within a database, serving as individual entries or data points within a table. Each default table in NocoDB is meticulously organized into a structured grid of records, fields (columns), and cells. These records constitute the backbone of data storage and retrieval within NocoDB, encapsulating a diverse range of information types, including text, numerical values, dates, file attachments, and even links to other records, either within the same table or across different tables. This versatile approach allows users to create highly customizable databases tailored to their specific data management needs, all centered around the concept of records.

    In essence, a record can be envisaged as a horizontal collection of data within a NocoDB table, each record representing a distinct piece of information. These records play a pivotal role in organizing, categorizing, and presenting data in a comprehensible and efficient manner, offering users a structured and organized platform for data management.

    You can perform a variety of actions to efficiently manage your data. To get started, you can create a new record to input essential information. If you need to make updates to an existing record, you can modify it or even perform a bulk update for multiple records simultaneously. For records that are no longer needed, you have the option to delete or duplicate them with ease. When you're working with records, you can also benefit from our expanded form for a more detailed view, complete with a record change log to track all modifications and a feature to write comments for more context and collaboration. Additionally, you can share records quickly by generating a shareable URL.

    In this section, we'll explore the various aspects of records in NocoDB, equipping you with the knowledge to effectively manage your own data.

    - +
    Version: Latest

    Records overview

    Records in NocoDB are fundamental components within a database, serving as individual entries or data points within a table. Each default table in NocoDB is meticulously organized into a structured grid of records, fields (columns), and cells. These records constitute the backbone of data storage and retrieval within NocoDB, encapsulating a diverse range of information types, including text, numerical values, dates, file attachments, and even links to other records, either within the same table or across different tables. This versatile approach allows users to create highly customizable databases tailored to their specific data management needs, all centered around the concept of records.

    In essence, a record can be envisaged as a horizontal collection of data within a NocoDB table, each record representing a distinct piece of information. These records play a pivotal role in organizing, categorizing, and presenting data in a comprehensible and efficient manner, offering users a structured and organized platform for data management.

    You can perform a variety of actions to efficiently manage your data. To get started, you can create a new record to input essential information. If you need to make updates to an existing record, you can modify it or even perform a bulk update for multiple records simultaneously. For records that are no longer needed, you have the option to delete or duplicate them with ease. When you're working with records, you can also benefit from our expanded form for a more detailed view, complete with a record change log to track all modifications and a feature to write comments for more context and collaboration. Additionally, you can share records quickly by generating a shareable URL.

    In this section, we'll explore the various aspects of records in NocoDB, equipping you with the knowledge to effectively manage your own data.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/roles-and-permissions/roles-permissions-overview/index.html b/packages/noco-docs/dist/roles-and-permissions/roles-permissions-overview/index.html index 12cdd16810..c2bd41e6e8 100644 --- a/packages/noco-docs/dist/roles-and-permissions/roles-permissions-overview/index.html +++ b/packages/noco-docs/dist/roles-and-permissions/roles-permissions-overview/index.html @@ -4,12 +4,12 @@ Roles & permissions overview | NocoDB - +
    -
    Version: Latest

    Roles & permissions overview

    In NocoDB, we have roles that determine what people can do in a Workspace or Base.

    You can give a member one of these roles:

    • Creator
    • Editor
    • Commenter
    • Viewer
    info

    Role for a member, if assigned at base level carry precedence over workspace level role.

    When inviting a user, their role designation is initially assigned but can be modified later. Our role system +

    Version: Latest

    Roles & permissions overview

    In NocoDB, we have roles that determine what people can do in a Workspace or Base.

    You can give a member one of these roles:

    • Creator
    • Editor
    • Commenter
    • Viewer
    info

    Role for a member, if assigned at base level carry precedence over workspace level role.

    When inviting a user, their role designation is initially assigned but can be modified later. Our role system operates incrementally, with higher-level roles encompassing all privileges of lower-level roles. This hierarchy offers flexibility in permissions and fosters a transparent organizational structure in workspace or base management.

    Roles​

    Roles serve as the basis for user privileges in NocoDB. They are associated with members at two levels: @@ -29,7 +29,7 @@ A workspace can have only one Owner. Access to bases within that workspace is gr within the parent workspace. When a member becomes part of a workspace, the role at the workspace level is automatically applied to them for all bases in that workspace, unless a specific exception is configured to override at base level.

    TaskOwnerCreatorEditorCommenterViewer
    Invite member to workspace✔️✔️
    Manage member access to workspace✔️✔️
    Remove member access from workspace✔️✔️
    View members in workspace✔️✔️
    Delete Workspace✔️️
    Billing & upgrade options✔️️
    Create a new base✔️✔️✔️✔️✔️
    Access existing bases at assigned roles✔️✔️✔️✔️✔️

    Base level permissions​

    Collaboration​

    TaskOwnerCreatorEditorCommenterViewer
    Invite members to base at or below your role✔️✔️
    Manage members access to base✔️✔️
    Remove member access from a base✔️✔️
    View members in a base✔️✔️
    Share base✔️✔️
    Share view✔️✔️

    Table & view operations​

    TaskOwnerCreatorEditorCommenterViewer
    Add / modify / delete table✔️✔️
    Add / modify / delete fields✔️✔️
    Add / modify / delete views✔️✔️
    Hide / un-hide / reorder fields✔️✔️✔️✔️✔️
    Add / modify / delete sort✔️✔️✔️✔️✔️
    Add / modify / delete filters✔️✔️✔️✔️✔️
    Add / modify / delete group-by✔️✔️✔️✔️✔️

    Record operations​

    TaskOwnerCreatorEditorCommenterViewer
    Add / modify / delete record✔️✔️
    View & add comment on a record✔️✔️✔️✔️
    View record✔️✔️✔️✔️✔️

    Automations & advanced​

    TaskOwnerCreatorEditorCommenterViewer
    Add / modify / delete Webhook✔️✔️
    ERD (Project & Table relations)✔️✔️✔️✔️✔️
    API Snippet✔️✔️✔️✔️✔️
    API Token✔️✔️✔️✔️✔️
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/search/index.html b/packages/noco-docs/dist/search/index.html index dedbda217c..8c0cd3b524 100644 --- a/packages/noco-docs/dist/search/index.html +++ b/packages/noco-docs/dist/search/index.html @@ -4,13 +4,13 @@ Search the documentation | NocoDB - +

    Search the documentation

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/table-details/table-details-overview/index.html b/packages/noco-docs/dist/table-details/table-details-overview/index.html index 361bf27486..6c7989b770 100644 --- a/packages/noco-docs/dist/table-details/table-details-overview/index.html +++ b/packages/noco-docs/dist/table-details/table-details-overview/index.html @@ -4,13 +4,13 @@ Table details overview | NocoDB - +
    -
    Version: Latest

    Table details overview

    Table Details section houses various tools & utilities to manage & work with your table schema & data. This essentially is a place for 'Creators' to build & manage their tables quickly. Details section is accessible using the Data-Details toggle switcher in the top navbar.

    image

    This section is divided into 4 parts:

    Fields​

    Fields is a multi-field table schema editor that allows you to add, edit, delete and reorder fields quickly & easily from one place. Additional details about multi-field editor can be found here

    image

    Relations​

    Relations are vital for managing data connections in a database. In a complex schema, it's essential to have a clear understanding of these connections because they:

    1. Maintain data accuracy.
    2. Enhance query efficiency.
    3. Aid in logical schema design.
    4. Support data analysis.
    5. Enable proper application development.

    Visualizing these relations through an Entity Relationship Diagram (ERD) simplifies their comprehension and management, especially as the database grows in complexity.

    image

    note

    You can drag drop the tables to rearrange them in the diagram. Note that, such reordering will not persist across sessions.

    API Snippet​

    NocoDB provides programmatic access to your data via REST APIs. API snippets in NocoDB offer ready-made code examples in various programming languages, simplifying the process of integrating your data with external applications. These snippets save time and effort by providing a quick and easy reference for developers, enabling them to interact with your NocoDB database programmatically without the need to write code from scratch.

    A quick snippet for different scripts & languages is listed in this section.

    image

    Sample snippets​

    curl --request GET \
      --url 'http://localhost:8080/api/v1/db/data/noco/p18h72lcfwzpsvu/Customer/views/Customer?offset=0&limit=25&where=' \
      --header 'xc-auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InVzZXJAbm9jb2RiLmNvbSIsImRpc3BsYXlfbmFtZSI6IlJpY2hhcmQiLCJhdmF0YXIiOm51bGwsInVzZXJfbmFtZSI6bnVsbCwiaWQiOiJ1c3ExbGNpeWp4ejh5bzY4Iiwicm9sZXMiOnsib3JnLWxldmVsLXZpZXdlciI6dHJ1ZX0sInRva2VuX3ZlcnNpb24iOiI0ZjUyOTUxZGQwOTZmMTVjMTY0Y2U5MDM1OTk1YzlmMDE1MTJjMGNjOThkYmRiMDU2ZmFhM2JhZWE1OWY4Y2QzMTcyN2FjOWZkMTJjNDA2ZiIsImlhdCI6MTY5NTk5MTg0NywiZXhwIjoxNjk2MDI3ODQ3fQ.I7P5caoiDSO4j_3D032XxWxxXwyEju6pL5y3Mnu_MNU'

    Supported Snippet​

    Shell​

    • cURL
    • wget

    Javascript​

    • Axios
    • Fetch
    • jQuery
    • XHR

    Node​

    • Axios
    • Fetch
    • Request
    • Native
    • Unirest

    NocoDB SDK​

    • Javascript
    • Node

    PHP​

    Python​

    • http.client
    • request

    Ruby​

    Java​

    C​

    Webhook​

    Webhooks are essential for real-time communication and automation between NocoDB and external systems. They serve several crucial purposes:

    1. Instant Notifications: Webhooks enable immediate notifications when there are changes in your NocoDB database. This real-time information can be crucial for timely responses to important events, such as new data entries, updates, or deletions.

    2. Automation: They facilitate the automation of processes by triggering actions in external systems based on database events. For example, you can automate tasks like sending emails, updating spreadsheets, or syncing data with other applications in response to changes in NocoDB.

    3. Integration: Webhooks allow you to seamlessly integrate NocoDB with other tools and services, enhancing the overall functionality of your database. This integration can streamline workflows, improve data consistency, and reduce manual data entry.

    4. Bulk Operations: NocoDB's support for webhooks in bulk endpoints makes it efficient to handle multiple records simultaneously. This is especially useful when dealing with large datasets or when you need to perform batch operations in external systems.

    In summary, webhooks in NocoDB empower you to create dynamic, responsive, and interconnected workflows by keeping external systems in sync with your database's activities.

    image

    Note that, Webhooks currently are specific for associated table. Additional procedural details about webhooks can be found here

    - +
    Version: Latest

    Table details overview

    Table Details section houses various tools & utilities to manage & work with your table schema & data. This essentially is a place for 'Creators' to build & manage their tables quickly. Details section is accessible using the Data-Details toggle switcher in the top navbar.

    image

    This section is divided into 4 parts:

    Fields​

    Fields is a multi-field table schema editor that allows you to add, edit, delete and reorder fields quickly & easily from one place. Additional details about multi-field editor can be found here

    image

    Relations​

    Relations are vital for managing data connections in a database. In a complex schema, it's essential to have a clear understanding of these connections because they:

    1. Maintain data accuracy.
    2. Enhance query efficiency.
    3. Aid in logical schema design.
    4. Support data analysis.
    5. Enable proper application development.

    Visualizing these relations through an Entity Relationship Diagram (ERD) simplifies their comprehension and management, especially as the database grows in complexity.

    image

    note

    You can drag drop the tables to rearrange them in the diagram. Note that, such reordering will not persist across sessions.

    API Snippet​

    NocoDB provides programmatic access to your data via REST APIs. API snippets in NocoDB offer ready-made code examples in various programming languages, simplifying the process of integrating your data with external applications. These snippets save time and effort by providing a quick and easy reference for developers, enabling them to interact with your NocoDB database programmatically without the need to write code from scratch.

    A quick snippet for different scripts & languages is listed in this section.

    image

    Sample snippets​

    curl --request GET \
      --url 'http://localhost:8080/api/v1/db/data/noco/p18h72lcfwzpsvu/Customer/views/Customer?offset=0&limit=25&where=' \
      --header 'xc-auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InVzZXJAbm9jb2RiLmNvbSIsImRpc3BsYXlfbmFtZSI6IlJpY2hhcmQiLCJhdmF0YXIiOm51bGwsInVzZXJfbmFtZSI6bnVsbCwiaWQiOiJ1c3ExbGNpeWp4ejh5bzY4Iiwicm9sZXMiOnsib3JnLWxldmVsLXZpZXdlciI6dHJ1ZX0sInRva2VuX3ZlcnNpb24iOiI0ZjUyOTUxZGQwOTZmMTVjMTY0Y2U5MDM1OTk1YzlmMDE1MTJjMGNjOThkYmRiMDU2ZmFhM2JhZWE1OWY4Y2QzMTcyN2FjOWZkMTJjNDA2ZiIsImlhdCI6MTY5NTk5MTg0NywiZXhwIjoxNjk2MDI3ODQ3fQ.I7P5caoiDSO4j_3D032XxWxxXwyEju6pL5y3Mnu_MNU'

    Supported Snippet​

    Shell​

    • cURL
    • wget

    Javascript​

    • Axios
    • Fetch
    • jQuery
    • XHR

    Node​

    • Axios
    • Fetch
    • Request
    • Native
    • Unirest

    NocoDB SDK​

    • Javascript
    • Node

    PHP​

    Python​

    • http.client
    • request

    Ruby​

    Java​

    C​

    Webhook​

    Webhooks are essential for real-time communication and automation between NocoDB and external systems. They serve several crucial purposes:

    1. Instant Notifications: Webhooks enable immediate notifications when there are changes in your NocoDB database. This real-time information can be crucial for timely responses to important events, such as new data entries, updates, or deletions.

    2. Automation: They facilitate the automation of processes by triggering actions in external systems based on database events. For example, you can automate tasks like sending emails, updating spreadsheets, or syncing data with other applications in response to changes in NocoDB.

    3. Integration: Webhooks allow you to seamlessly integrate NocoDB with other tools and services, enhancing the overall functionality of your database. This integration can streamline workflows, improve data consistency, and reduce manual data entry.

    4. Bulk Operations: NocoDB's support for webhooks in bulk endpoints makes it efficient to handle multiple records simultaneously. This is especially useful when dealing with large datasets or when you need to perform batch operations in external systems.

    In summary, webhooks in NocoDB empower you to create dynamic, responsive, and interconnected workflows by keeping external systems in sync with your database's activities.

    image

    Note that, Webhooks currently are specific for associated table. Additional procedural details about webhooks can be found here

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/table-operations/download/index.html b/packages/noco-docs/dist/table-operations/download/index.html index 794c7a9b32..7f5dd1668f 100644 --- a/packages/noco-docs/dist/table-operations/download/index.html +++ b/packages/noco-docs/dist/table-operations/download/index.html @@ -4,13 +4,13 @@ Download | NocoDB - +
    -
    Version: Latest

    Download

    NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.

    Download Data​

    To export data from NocoDB, follow these steps:

    1. Click on the ... button in the toolbar menu.
    2. Choose the Download option.
    3. Select the desired file format from the dropdown menu.

    Export

    - +
    Version: Latest

    Download

    NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.

    Download Data​

    To export data from NocoDB, follow these steps:

    1. Click on the ... button in the toolbar menu.
    2. Choose the Download option.
    3. Select the desired file format from the dropdown menu.

    Export

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/table-operations/field-operations/index.html b/packages/noco-docs/dist/table-operations/field-operations/index.html index 9e4f1ef39d..5a7e8133bf 100644 --- a/packages/noco-docs/dist/table-operations/field-operations/index.html +++ b/packages/noco-docs/dist/table-operations/field-operations/index.html @@ -4,13 +4,13 @@ Hide & reorder fields | NocoDB - +
    -
    Version: Latest

    Hide & reorder fields

    Utilize the Fields button in the toolbar to manage the visibility of fields within the system. By default, all system-related fields are concealed, but you have the option to enable them by selecting Show system fields.

    info

    For Gallery View & Kanban View, the Fields menu is available on the toolbar as Edit Cards.

    Show system fields

    Rearranging Fields​

    You have the flexibility to rearrange field positions. Access the Fields menu and reorder fields effortlessly by dragging and dropping the associated field using the provided drag icon.

    Reorder Fields

    Show/Hide Fields​

    For showing or hiding fields, navigate to the Fields menu and simply click the toggle button associated with the respective field to hide or un-hide it.

    tip

    Consider creating different grid views with distinct sets of fields displayed in each view for enhanced customization.

    Show/Hide Fields

    Change cover field (Gallery/Kanban View)​

    For Gallery View & Kanban View, you can change the cover field by clicking on the Change cover field button in the Edit Cards menu. You can select any field of type Attachment as the cover field.

    Change cover field

    - +
    Version: Latest

    Hide & reorder fields

    Utilize the Fields button in the toolbar to manage the visibility of fields within the system. By default, all system-related fields are concealed, but you have the option to enable them by selecting Show system fields.

    info

    For Gallery View & Kanban View, the Fields menu is available on the toolbar as Edit Cards.

    Show system fields

    Rearranging Fields​

    You have the flexibility to rearrange field positions. Access the Fields menu and reorder fields effortlessly by dragging and dropping the associated field using the provided drag icon.

    Reorder Fields

    Show/Hide Fields​

    For showing or hiding fields, navigate to the Fields menu and simply click the toggle button associated with the respective field to hide or un-hide it.

    tip

    Consider creating different grid views with distinct sets of fields displayed in each view for enhanced customization.

    Show/Hide Fields

    Change cover field (Gallery/Kanban View)​

    For Gallery View & Kanban View, you can change the cover field by clicking on the Change cover field button in the Edit Cards menu. You can select any field of type Attachment as the cover field.

    Change cover field

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/table-operations/filter/index.html b/packages/noco-docs/dist/table-operations/filter/index.html index 3b4bfb0861..68c58c0458 100644 --- a/packages/noco-docs/dist/table-operations/filter/index.html +++ b/packages/noco-docs/dist/table-operations/filter/index.html @@ -4,13 +4,13 @@ Filtering records | NocoDB - +
    -
    Version: Latest

    Filtering records

    Filters provide a powerful way to narrow down and organize your data according to your specific requirements. NocoDB supports nested filters, allowing you to select multiple fields and conditions for filtering. You can choose between and or or mode of operation to combine filters, and filtering also supports Lookup, Formula, and Nested Data.

    Adding or Editing Filters​

    To add or edit a filter, simply click the Filter button in the toolbar and select either Add filter or Add filter group.

    Add Filter

    Configure the filter by specifying the Field, Operation, and Value (if applicable).

    Filter Configuration

    You can combine multiple filter conditions using either And or Or mode of operation.

    Nested Filters

    Deleting Filters​

    To remove a filter, click on the bin icon located to the right of the respective filter.

    Delete Filter

    Grouping Filters​

    You also have the option to group multiple filters together using a Filter Group.

    Grouped Filters

    Enabling NULL and EMPTY Filters​

    By default, NULL filters (is null & is not null) and EMPTY filters (is empty & is not empty) are hidden. If you wish to filter out either of these explicitly, you can enable Show NULL and EMPTY Filter in Project settings.

    Before enabling Show NULL and EMPTY Filter:

    Show isBlank

    Once enabled, you can use the is null & is empty filters to filter out cells with NULL or EMPTY values.

    Show NULL and EMPTY Filter

    Alternatively, you can use Blank filters to filter out cells with NULL or EMPTY values.

    Supported Filters​

    NocoDB currently supports various types of filters for corresponding fields. Please refer to the matrix below for detailed information.

    Filter Matrix

    - +
    Version: Latest

    Filtering records

    Filters provide a powerful way to narrow down and organize your data according to your specific requirements. NocoDB supports nested filters, allowing you to select multiple fields and conditions for filtering. You can choose between and or or mode of operation to combine filters, and filtering also supports Lookup, Formula, and Nested Data.

    Adding or Editing Filters​

    To add or edit a filter, simply click the Filter button in the toolbar and select either Add filter or Add filter group.

    Add Filter

    Configure the filter by specifying the Field, Operation, and Value (if applicable).

    Filter Configuration

    You can combine multiple filter conditions using either And or Or mode of operation.

    Nested Filters

    Deleting Filters​

    To remove a filter, click on the bin icon located to the right of the respective filter.

    Delete Filter

    Grouping Filters​

    You also have the option to group multiple filters together using a Filter Group.

    Grouped Filters

    Enabling NULL and EMPTY Filters​

    By default, NULL filters (is null & is not null) and EMPTY filters (is empty & is not empty) are hidden. If you wish to filter out either of these explicitly, you can enable Show NULL and EMPTY Filter in Project settings.

    Before enabling Show NULL and EMPTY Filter:

    Show isBlank

    Once enabled, you can use the is null & is empty filters to filter out cells with NULL or EMPTY values.

    Show NULL and EMPTY Filter

    Alternatively, you can use Blank filters to filter out cells with NULL or EMPTY values.

    Supported Filters​

    NocoDB currently supports various types of filters for corresponding fields. Please refer to the matrix below for detailed information.

    Filter Matrix

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/table-operations/group-by/index.html b/packages/noco-docs/dist/table-operations/group-by/index.html index 1997c2209b..3aac353b14 100644 --- a/packages/noco-docs/dist/table-operations/group-by/index.html +++ b/packages/noco-docs/dist/table-operations/group-by/index.html @@ -4,13 +4,13 @@ Grouping records | NocoDB - +
    -
    Version: Latest

    Grouping records

    Grouping records in NocoDB allows for efficient categorization of data into specific Groups and Subgroups. NocoDB supports three levels of record segregation, providing a powerful organizational tool.

    Group By

    Adding or Editing Groups​

    To create or modify a grouping in NocoDB, follow these steps:

    1. Click on Group By in the toolbar.
    2. Choose the field by which you want to group the records.
    3. Optionally, you can sort the groups in ascending or descending order.

    Group By

    info

    You can add subgroups with up to three levels to further refine your categorization.

    Group By

    Deleting Groups​

    To remove a grouping in NocoDB, take these actions:

    1. Click on Group By in the toolbar.
    2. Locate the bin icon to the right of the group you wish to delete and click on it.
    info

    To disable Group By and return to the standard spreadsheet grid view, you must remove all configured groups.

    Group By

    - +
    Version: Latest

    Grouping records

    Grouping records in NocoDB allows for efficient categorization of data into specific Groups and Subgroups. NocoDB supports three levels of record segregation, providing a powerful organizational tool.

    Group By

    Adding or Editing Groups​

    To create or modify a grouping in NocoDB, follow these steps:

    1. Click on Group By in the toolbar.
    2. Choose the field by which you want to group the records.
    3. Optionally, you can sort the groups in ascending or descending order.

    Group By

    info

    You can add subgroups with up to three levels to further refine your categorization.

    Group By

    Deleting Groups​

    To remove a grouping in NocoDB, take these actions:

    1. Click on Group By in the toolbar.
    2. Locate the bin icon to the right of the group you wish to delete and click on it.
    info

    To disable Group By and return to the standard spreadsheet grid view, you must remove all configured groups.

    Group By

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/table-operations/overview/index.html b/packages/noco-docs/dist/table-operations/overview/index.html index 44953a2cdd..eb59c88cba 100644 --- a/packages/noco-docs/dist/table-operations/overview/index.html +++ b/packages/noco-docs/dist/table-operations/overview/index.html @@ -4,13 +4,13 @@ Table operations overview | NocoDB - +
    -
    - +
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/table-operations/row-height/index.html b/packages/noco-docs/dist/table-operations/row-height/index.html index bf50cfb0ef..57fd1c80a6 100644 --- a/packages/noco-docs/dist/table-operations/row-height/index.html +++ b/packages/noco-docs/dist/table-operations/row-height/index.html @@ -4,13 +4,13 @@ Record height | NocoDB - +
    -
    Version: Latest

    Record height

    NocoDB offers users the flexibility to adjust the display height of records within the spreadsheet grid to four distinct levels: Short (the default setting), Medium, Tall, and Extra. This feature proves valuable when working with extensive text fields and multi-select fields, as it enables users to present a greater amount of content within each cell.

    record height

    Short​

    Short

    Medium​

    Medium

    Tall​

    Tall

    Extra​

    Extra

    - +
    Version: Latest

    Record height

    NocoDB offers users the flexibility to adjust the display height of records within the spreadsheet grid to four distinct levels: Short (the default setting), Medium, Tall, and Extra. This feature proves valuable when working with extensive text fields and multi-select fields, as it enables users to present a greater amount of content within each cell.

    record height

    Short​

    Short

    Medium​

    Medium

    Tall​

    Tall

    Extra​

    Extra

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/table-operations/search/index.html b/packages/noco-docs/dist/table-operations/search/index.html index b2b26ec8ee..afd9156aed 100644 --- a/packages/noco-docs/dist/table-operations/search/index.html +++ b/packages/noco-docs/dist/table-operations/search/index.html @@ -4,13 +4,13 @@ Search | NocoDB - +
    -
    Version: Latest

    Search

    NocoDB offers a quick search feature that allows you to search for records by field from the toolbar menu. This feature is useful when working with large datasets and can be used in conjunction with the Filter feature to further refine your search results.

    1. Click on the Search button in the toolbar menu (Optional)
    2. Choose the Field to search by (Optional)
    3. Enter the search term in the search bar.

    image

    - +
    Version: Latest

    Search

    NocoDB offers a quick search feature that allows you to search for records by field from the toolbar menu. This feature is useful when working with large datasets and can be used in conjunction with the Filter feature to further refine your search results.

    1. Click on the Search button in the toolbar menu (Optional)
    2. Choose the Field to search by (Optional)
    3. Enter the search term in the search bar.

    image

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/table-operations/sort/index.html b/packages/noco-docs/dist/table-operations/sort/index.html index 0d85002037..d2cce3bb74 100644 --- a/packages/noco-docs/dist/table-operations/sort/index.html +++ b/packages/noco-docs/dist/table-operations/sort/index.html @@ -4,13 +4,13 @@ Sorting records | NocoDB - +
    -
    Version: Latest

    Sorting records

    Sorting enables you to arrange your data alphabetically (A → Z) or (Z → A) for text based types and in ascending or descending order for numerical types. NocoDB supports nested sorting, allowing you to select fields and the order in which to apply nested sorting.

    Adding or Editing Sort​

    1. Click the Sort button in the toolbar menu.
    2. Choose the Field to sort by.
    3. Configure the sorting Direction : ascending or descending

    Sort Field

    Sort Direction

    • You can configure multiple fields for subsequent-level sorting.

    Nested Sorting

    info

    Field configured at the top will be used for the first-level sorting, followed by subsequent fields in a top-down order

    Deleting Sort​

    • Click the Sort button in the toolbar.
      • Click on the bin icon to the right of the sort you wish to delete.

    Delete Sorting

    - +
    Version: Latest

    Sorting records

    Sorting enables you to arrange your data alphabetically (A → Z) or (Z → A) for text based types and in ascending or descending order for numerical types. NocoDB supports nested sorting, allowing you to select fields and the order in which to apply nested sorting.

    Adding or Editing Sort​

    1. Click the Sort button in the toolbar menu.
    2. Choose the Field to sort by.
    3. Configure the sorting Direction : ascending or descending

    Sort Field

    Sort Direction

    • You can configure multiple fields for subsequent-level sorting.

    Nested Sorting

    info

    Field configured at the top will be used for the first-level sorting, followed by subsequent fields in a top-down order

    Deleting Sort​

    • Click the Sort button in the toolbar.
      • Click on the bin icon to the right of the sort you wish to delete.

    Delete Sorting

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/tables/actions-on-table/index.html b/packages/noco-docs/dist/tables/actions-on-table/index.html index 65f6b0933f..8ae0715649 100644 --- a/packages/noco-docs/dist/tables/actions-on-table/index.html +++ b/packages/noco-docs/dist/tables/actions-on-table/index.html @@ -4,15 +4,15 @@ Actions on table | NocoDB - +
    -
    Version: Latest

    Actions on table

    Rename table​

    1. Access the contextual menu for the table by clicking on the ellipsis symbol (...) located in the left sidebar.
    2. Click on the Rename option from the context menu.
    3. Enter the desired new table name into the provided field.
    4. To finalize the renaming process, click on the Rename button.

    image

    image

    Change table icon​

    1. Click on the existing table icon to the left of the table name in the left sidebar.
    2. Select the desired icon from the list of available options.

    image

    Duplicate table​

    1. Access the contextual menu for the table by clicking on the ellipsis symbol (...) located in the left sidebar.
    2. Click on the Duplicate option from the context menu.
    3. For additional customization (Optional) +
      Version: Latest

      Actions on table

      Rename table​

      1. Access the contextual menu for the table by clicking on the ellipsis symbol (...) located in the left sidebar.
      2. Click on the Rename option from the context menu.
      3. Enter the desired new table name into the provided field.
      4. To finalize the renaming process, click on the Rename button.

      image

      image

      Change table icon​

      1. Click on the existing table icon to the left of the table name in the left sidebar.
      2. Select the desired icon from the list of available options.

      image

      Duplicate table​

      1. Access the contextual menu for the table by clicking on the ellipsis symbol (...) located in the left sidebar.
      2. Click on the Duplicate option from the context menu.
      3. For additional customization (Optional) a) Under Include data, you have the flexibility to choose whether to replicate the table with or without its data. b) Regarding Include views you can select whether to duplicate the table with or without its associated views.
      4. Proceed by clicking the Duplicate Table button found in the confirmation dialog.

      A new table will be generated, mirroring the original table's schema and content, in accordance with the configurations specified in step 3.

      image

      image

      info
      • Duplicate table will be created in the same base as the original table
      • Duplicate table will carry suffix Copy in its name.
      • Duplicate table option is not available for External DB projects

      Delete table​

      danger

      This action cannot be undone.

      1. Access the contextual menu for the table by clicking on the ellipsis symbol (...) located in the left sidebar.
      2. Click on the Delete option from the context menu.
      3. To finalize the deletion process, click on the Delete button in the confirmation dialog.

      image

      image

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tables/create-table-via-import/index.html b/packages/noco-docs/dist/tables/create-table-via-import/index.html index bcf08062ca..35c0cf2644 100644 --- a/packages/noco-docs/dist/tables/create-table-via-import/index.html +++ b/packages/noco-docs/dist/tables/create-table-via-import/index.html @@ -4,15 +4,15 @@ Create table via import | NocoDB - +
    -
    Version: Latest

    Create table via import

    Import table from CSV / Excel / JSON​

    Accessing import modal​

    There are two ways to access import modal:

    1. From the base dashboard​

    import data

    import from dashboard

    2. From the base context menu​

    import from sidebar

    Importing file​

    There are two ways to upload source file:

    1. Upload from local directory​

    1. Select Upload tab from the Quick import modal.
    2. Click on file upload button or drag and drop file to the modal.
    3. Advance Settings (optional)
    4. Click on Import button. +
      Version: Latest

      Create table via import

      Import table from CSV / Excel / JSON​

      Accessing import modal​

      There are two ways to access import modal:

      1. From the base dashboard​

      import data

      import from dashboard

      2. From the base context menu​

      import from sidebar

      Importing file​

      There are two ways to upload source file:

      1. Upload from local directory​

      1. Select Upload tab from the Quick import modal.
      2. Click on file upload button or drag and drop file to the modal.
      3. Advance Settings (optional)
      4. Click on Import button. image

      2. Upload from URL​

      1. Select URL tab from the Quick import modal.
      2. Paste the URL of the file.
      3. Advance Settings (optional)
      4. Click on Import button. image
      info
      • Multiple files can be imported at once.
      • Supported file formats: CSV, Excel, JSON
      • Maximum file size: 5 MB

      Import configurations​

      1. Table name - defaults to the name of the file; double click to edit (Optional).
      2. Field configurations (Optional)
        • Field name - name of the field as identified from import file header; click to edit.
        • Field type - inferred from the data in the field; click to edit.
        • Options - For Single select and Multi select field types, options identified are listed here; click to edit.
      3. Remove field - Click on delete icon to exclude a field in source file from being imported (Optional)
      4. Click on Import button to start importing the file.

      image

      Advanced Settings​

      • Number of Records for Datatype Inference: Default value is set to 500 records.
      • Automatic Field Type Detection: Enabled by default. If selected, the system will automatically detect field types. Otherwise, all fields will default to "SingleLineText."
      • Utilize First Records as Headers: Enabled by default. If selected, the first record in the spreadsheet will be treated as the header record and its contents will be used as field names.
      • Import Data: Enabled by default. If selected, all data will be imported; otherwise, only the table will be created.
      info

      By default, the first field will be chosen as Display Value and cannot be deleted.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tables/create-table/index.html b/packages/noco-docs/dist/tables/create-table/index.html index c177b4fb71..c971bddd62 100644 --- a/packages/noco-docs/dist/tables/create-table/index.html +++ b/packages/noco-docs/dist/tables/create-table/index.html @@ -4,14 +4,14 @@ Create empty table | NocoDB - +
    -
    Version: Latest

    Create empty table

    Create new table​

    1. Click on + on the left sidebar next to base name OR click on + New Table button on the Base dashboard.
    2. Fill table name in the pop-up modal.
    3. Click on Create Table button.

    image +

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tables/import-data-into-existing-table/index.html b/packages/noco-docs/dist/tables/import-data-into-existing-table/index.html index 182dcd6590..b55f4763f9 100644 --- a/packages/noco-docs/dist/tables/import-data-into-existing-table/index.html +++ b/packages/noco-docs/dist/tables/import-data-into-existing-table/index.html @@ -4,13 +4,13 @@ Import data into an existing table | NocoDB - +
    -
    Version: Latest

    Import data into an existing table

    Import data from CSV / Excel​

    Accessing import modal​

    1. Click on ... context menu from the toolbar.
    2. Click on Upload button.
    3. Select Upload CSV / Upload Excel option.

    image

    Importing file data​

    There are two ways to upload source file:

    1. Upload from local directory​

    1. Select Upload tab from the Quick import modal.
    2. Click on file upload button or drag and drop file to the modal.
    3. Advance Settings (optional)
    4. Click on Import button.

    image

    2. Upload from URL​

    1. Select URL tab from the Quick import modal.
    2. Paste the URL of the file.
    3. Advance Settings (optional)
    4. Click on Import button.

    image

    Field mapping​

    1. Table Name (Optional)

      • Defaults to the name of the file; double-click to edit.

    2. Mapping Fields (Optional)

      • Existing field names are listed under Source field, while new fields identified from the import file are listed under Destination field.
      • NocoDB automatically maps destination field names based on the source field names.
      • You can reconfigure the mapping by utilizing the dropdown menu that appears when you click on the destination field.

    3. Exclude fields (Optional)

      • A checkbox is provided to exclude a field from being imported.

    4. Initiate Import

      • Click on the Import button to commence the file import process.

    image

    Advance settings​

    • # of records to parse to infer datatype - defaults to 500 records.
    • Utilize First Record as Headers**`: Enabled by default. If selected, the first record in the spreadsheet will be treated as the header record and its contents will be used as field names.
    - +
    Version: Latest

    Import data into an existing table

    Import data from CSV / Excel​

    Accessing import modal​

    1. Click on ... context menu from the toolbar.
    2. Click on Upload button.
    3. Select Upload CSV / Upload Excel option.

    image

    Importing file data​

    There are two ways to upload source file:

    1. Upload from local directory​

    1. Select Upload tab from the Quick import modal.
    2. Click on file upload button or drag and drop file to the modal.
    3. Advance Settings (optional)
    4. Click on Import button.

    image

    2. Upload from URL​

    1. Select URL tab from the Quick import modal.
    2. Paste the URL of the file.
    3. Advance Settings (optional)
    4. Click on Import button.

    image

    Field mapping​

    1. Table Name (Optional)

      • Defaults to the name of the file; double-click to edit.

    2. Mapping Fields (Optional)

      • Existing field names are listed under Source field, while new fields identified from the import file are listed under Destination field.
      • NocoDB automatically maps destination field names based on the source field names.
      • You can reconfigure the mapping by utilizing the dropdown menu that appears when you click on the destination field.

    3. Exclude fields (Optional)

      • A checkbox is provided to exclude a field from being imported.

    4. Initiate Import

      • Click on the Import button to commence the file import process.

    image

    Advance settings​

    • # of records to parse to infer datatype - defaults to 500 records.
    • Utilize First Record as Headers**`: Enabled by default. If selected, the first record in the spreadsheet will be treated as the header record and its contents will be used as field names.
    + \ No newline at end of file diff --git a/packages/noco-docs/dist/tables/table-overview/index.html b/packages/noco-docs/dist/tables/table-overview/index.html index 99f803b059..72fd42e1bd 100644 --- a/packages/noco-docs/dist/tables/table-overview/index.html +++ b/packages/noco-docs/dist/tables/table-overview/index.html @@ -4,13 +4,13 @@ Table overview | NocoDB - +
    -
    Version: Latest

    Table overview

    A base is housed in tables, where data is logically arranged into records and fields. A table in NocoDB serves as a robust center for managing your data effectively. You have the flexibility to create multiple tables, each catering to distinct sets of data. Moreover, you can link tables to one another to establish relationships between them.

    Much like traditional spreadsheets, NocoDB tables empower you to carry out tasks such as sorting, filtering, and aggregating your data. What sets NocoDB apart from standard spreadsheets is its ability to present table data in various formats. You can view your data as a conventional grid with records and fields, a gallery of cards, or even as interactive kanban boards, and then make use of a friendly form to input data.

    You can start by learning how to create a new table, and if you have existing data in CSV, Excel, or JSON format, you can easily create a table via import. If you need to add more data to an existing table, we offer a simple way to import data from CSV or XLSX files. In case you want to make changes, you can rename a table, or if you need a copy of it, simply duplicate the table. And if you ever need to remove a table, we provide a straightforward option to delete it.

    As you delve into this section, you'll gain a deeper understanding of how to leverage NocoDB's tables effectively, equipping you to proficiently organize your own dataset.

    - +
    Version: Latest

    Table overview

    A base is housed in tables, where data is logically arranged into records and fields. A table in NocoDB serves as a robust center for managing your data effectively. You have the flexibility to create multiple tables, each catering to distinct sets of data. Moreover, you can link tables to one another to establish relationships between them.

    Much like traditional spreadsheets, NocoDB tables empower you to carry out tasks such as sorting, filtering, and aggregating your data. What sets NocoDB apart from standard spreadsheets is its ability to present table data in various formats. You can view your data as a conventional grid with records and fields, a gallery of cards, or even as interactive kanban boards, and then make use of a friendly form to input data.

    You can start by learning how to create a new table, and if you have existing data in CSV, Excel, or JSON format, you can easily create a table via import. If you need to add more data to an existing table, we offer a simple way to import data from CSV or XLSX files. In case you want to make changes, you can rename a table, or if you need a copy of it, simply duplicate the table. And if you ever need to remove a table, we provide a straightforward option to delete it.

    As you delve into this section, you'll gain a deeper understanding of how to leverage NocoDB's tables effectively, equipping you to proficiently organize your own dataset.

    + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/account-settings/index.html b/packages/noco-docs/dist/tags/account-settings/index.html index b016d782c6..140a3440ce 100644 --- a/packages/noco-docs/dist/tags/account-settings/index.html +++ b/packages/noco-docs/dist/tags/account-settings/index.html @@ -4,13 +4,13 @@ 3 docs tagged with "Account Settings" | NocoDB - +

    3 docs tagged with "Account Settings"

    View All Tags

    API tokens

    This article explains how to create and work with API Tokens.

    In Open Source

    This article explains Account settings specifics in Open source NocoDB.

    Profile page

    This article explains how to manage your profile page.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/api-tokens/index.html b/packages/noco-docs/dist/tags/api-tokens/index.html index 9ab6884aa0..5a26c1bf83 100644 --- a/packages/noco-docs/dist/tags/api-tokens/index.html +++ b/packages/noco-docs/dist/tags/api-tokens/index.html @@ -4,13 +4,13 @@ One doc tagged with "Api Tokens" | NocoDB - +

    One doc tagged with "Api Tokens"

    View All Tags

    API tokens

    This article explains how to create and work with API Tokens.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/attachment/index.html b/packages/noco-docs/dist/tags/attachment/index.html index 80ad66bc73..303ebae25f 100644 --- a/packages/noco-docs/dist/tags/attachment/index.html +++ b/packages/noco-docs/dist/tags/attachment/index.html @@ -4,13 +4,13 @@ One doc tagged with "Attachment" | NocoDB - +

    One doc tagged with "Attachment"

    View All Tags

    Attachment

    This article explains how to create & work with an Attachment field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/audit/index.html b/packages/noco-docs/dist/tags/audit/index.html index 1959d7f1ce..c4e5568007 100644 --- a/packages/noco-docs/dist/tags/audit/index.html +++ b/packages/noco-docs/dist/tags/audit/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "Audit" | NocoDB - +

    2 docs tagged with "Audit"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/barcode/index.html b/packages/noco-docs/dist/tags/barcode/index.html index b74eaef08e..2611602006 100644 --- a/packages/noco-docs/dist/tags/barcode/index.html +++ b/packages/noco-docs/dist/tags/barcode/index.html @@ -4,13 +4,13 @@ One doc tagged with "Barcode" | NocoDB - +

    One doc tagged with "Barcode"

    View All Tags

    Barcode

    This article explains how to create & work with a Barcode field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/bases/index.html b/packages/noco-docs/dist/tags/bases/index.html index 231de17059..2eb4de997a 100644 --- a/packages/noco-docs/dist/tags/bases/index.html +++ b/packages/noco-docs/dist/tags/bases/index.html @@ -4,13 +4,13 @@ 9 docs tagged with "Bases" | NocoDB - +

    9 docs tagged with "Bases"

    View All Tags

    Actions on base

    Actions you can perform on a base in NocoDB: Rename, duplicate, delete, star a base.

    Base overview

    This article explains the concept of bases in NocoDB.

    Share base

    Procedures to share a base & generating embedded iframe

    Share base

    Procedures to share a base publicly & generating embedded iframe

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/checkbox/index.html b/packages/noco-docs/dist/tags/checkbox/index.html index 586794b400..8a49aba87f 100644 --- a/packages/noco-docs/dist/tags/checkbox/index.html +++ b/packages/noco-docs/dist/tags/checkbox/index.html @@ -4,13 +4,13 @@ One doc tagged with "Checkbox" | NocoDB - +

    One doc tagged with "Checkbox"

    View All Tags

    Checkbox

    This article explains how to create & work with a Checkbox field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/collaboration/index.html b/packages/noco-docs/dist/tags/collaboration/index.html index 2694ea6bac..2003d22c96 100644 --- a/packages/noco-docs/dist/tags/collaboration/index.html +++ b/packages/noco-docs/dist/tags/collaboration/index.html @@ -4,13 +4,13 @@ 8 docs tagged with "Collaboration" | NocoDB - +

    8 docs tagged with "Collaboration"

    View All Tags

    In Open Source

    This article explains specifics of User management in OSS.

    Share base

    Procedures to share a base & generating embedded iframe

    Share base

    Procedures to share a base publicly & generating embedded iframe

    Workspace collaboration

    This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.

    Workspace collaboration

    This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/comments/index.html b/packages/noco-docs/dist/tags/comments/index.html index 18520a77e6..300c304f58 100644 --- a/packages/noco-docs/dist/tags/comments/index.html +++ b/packages/noco-docs/dist/tags/comments/index.html @@ -4,13 +4,13 @@ One doc tagged with "Comments" | NocoDB - +

    One doc tagged with "Comments"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/connect/index.html b/packages/noco-docs/dist/tags/connect/index.html index 09c61bdd53..2c2abe6a2e 100644 --- a/packages/noco-docs/dist/tags/connect/index.html +++ b/packages/noco-docs/dist/tags/connect/index.html @@ -4,13 +4,13 @@ One doc tagged with "Connect" | NocoDB - +

    One doc tagged with "Connect"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/cover-image/index.html b/packages/noco-docs/dist/tags/cover-image/index.html index e4a7a5eb35..380ac53da5 100644 --- a/packages/noco-docs/dist/tags/cover-image/index.html +++ b/packages/noco-docs/dist/tags/cover-image/index.html @@ -4,13 +4,13 @@ One doc tagged with "Cover image" | NocoDB - +

    One doc tagged with "Cover image"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/create/index.html b/packages/noco-docs/dist/tags/create/index.html index ca7caa42e2..e31053fb2d 100644 --- a/packages/noco-docs/dist/tags/create/index.html +++ b/packages/noco-docs/dist/tags/create/index.html @@ -4,13 +4,13 @@ 6 docs tagged with "Create" | NocoDB - +

    6 docs tagged with "Create"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/csv/index.html b/packages/noco-docs/dist/tags/csv/index.html index e152a1106e..98bb3d34f5 100644 --- a/packages/noco-docs/dist/tags/csv/index.html +++ b/packages/noco-docs/dist/tags/csv/index.html @@ -4,13 +4,13 @@ 3 docs tagged with "CSV" | NocoDB - +

    3 docs tagged with "CSV"

    View All Tags

    Download

    NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/currency/index.html b/packages/noco-docs/dist/tags/currency/index.html index 46d88132a3..cbf854234f 100644 --- a/packages/noco-docs/dist/tags/currency/index.html +++ b/packages/noco-docs/dist/tags/currency/index.html @@ -4,13 +4,13 @@ One doc tagged with "Currency" | NocoDB - +

    One doc tagged with "Currency"

    View All Tags

    Currency

    This article explains how to create & work with a Currency field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/custom-types/index.html b/packages/noco-docs/dist/tags/custom-types/index.html index d02e4677dc..28e96ae7ee 100644 --- a/packages/noco-docs/dist/tags/custom-types/index.html +++ b/packages/noco-docs/dist/tags/custom-types/index.html @@ -4,13 +4,13 @@ 8 docs tagged with "Custom types" | NocoDB - +

    8 docs tagged with "Custom types"

    View All Tags

    Attachment

    This article explains how to create & work with an Attachment field.

    Barcode

    This article explains how to create & work with a Barcode field.

    Checkbox

    This article explains how to create & work with a Checkbox field.

    Geometry

    This article explains how to create & work with a Geometry field.

    JSON

    JSON is a custom field type that allows you to store JSON data in a field. Useful for storing data that can be represented as a JSON object, like API Response, or a set of key-value pairs.

    QR code

    This article explains how to create & work with a QR code field.

    Rating

    This article explains how to create & work with a Rating field.

    Specific DB type

    This article explains how to create & work with a Specific DB Type field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/dashboard/index.html b/packages/noco-docs/dist/tags/dashboard/index.html index 51a7484919..b29709dd5a 100644 --- a/packages/noco-docs/dist/tags/dashboard/index.html +++ b/packages/noco-docs/dist/tags/dashboard/index.html @@ -4,13 +4,13 @@ One doc tagged with "Dashboard" | NocoDB - +

    One doc tagged with "Dashboard"

    View All Tags

    Base overview

    This article explains the concept of bases in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/data-sources/index.html b/packages/noco-docs/dist/tags/data-sources/index.html index 2e0ce0d887..f99345c207 100644 --- a/packages/noco-docs/dist/tags/data-sources/index.html +++ b/packages/noco-docs/dist/tags/data-sources/index.html @@ -4,13 +4,13 @@ 4 docs tagged with "Data sources" | NocoDB - +

    4 docs tagged with "Data sources"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/date-time/index.html b/packages/noco-docs/dist/tags/date-time/index.html index edc83ecc1a..5dcd8a6f54 100644 --- a/packages/noco-docs/dist/tags/date-time/index.html +++ b/packages/noco-docs/dist/tags/date-time/index.html @@ -4,13 +4,13 @@ 5 docs tagged with "Date & Time" | NocoDB - +

    5 docs tagged with "Date & Time"

    View All Tags

    Date

    This article explains how to create & work with a Date field.

    Date functions

    This article explains various date functions that can be used in formula fields.

    Date Time

    This article explains how to create & work with a Date Time field.

    Duration

    This article explains how to create & work with a Duration field.

    Time

    This article explains how to create & work with a Time field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/decimal/index.html b/packages/noco-docs/dist/tags/decimal/index.html index bb635b1842..bcf1af03f7 100644 --- a/packages/noco-docs/dist/tags/decimal/index.html +++ b/packages/noco-docs/dist/tags/decimal/index.html @@ -4,13 +4,13 @@ One doc tagged with "Decimal" | NocoDB - +

    One doc tagged with "Decimal"

    View All Tags

    Decimal

    This article explains how to create & work with a Decimal field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/delete/index.html b/packages/noco-docs/dist/tags/delete/index.html index 42577055f8..5d0929a6e7 100644 --- a/packages/noco-docs/dist/tags/delete/index.html +++ b/packages/noco-docs/dist/tags/delete/index.html @@ -4,13 +4,13 @@ 7 docs tagged with "Delete" | NocoDB - +

    7 docs tagged with "Delete"

    View All Tags

    Actions on base

    Actions you can perform on a base in NocoDB: Rename, duplicate, delete, star a base.

    Actions on field

    This article explains how to perform various actions on a field- like rename, change field type, default, field width, record height, show/hide.

    Actions on record

    Learn how to perform actions (edit, duplicate, delete, etc) on a record in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/disable/index.html b/packages/noco-docs/dist/tags/disable/index.html index 9290dad278..3184114c88 100644 --- a/packages/noco-docs/dist/tags/disable/index.html +++ b/packages/noco-docs/dist/tags/disable/index.html @@ -4,13 +4,13 @@ One doc tagged with "Disable" | NocoDB - +

    One doc tagged with "Disable"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/display-value/index.html b/packages/noco-docs/dist/tags/display-value/index.html index 87fe63a990..47ec125dc7 100644 --- a/packages/noco-docs/dist/tags/display-value/index.html +++ b/packages/noco-docs/dist/tags/display-value/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "Display value" | NocoDB - +

    2 docs tagged with "Display value"

    View All Tags

    Actions on field

    This article explains how to perform various actions on a field- like rename, change field type, default, field width, record height, show/hide.

    Display value

    This article explains how to set display value for a table & its use.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/download/index.html b/packages/noco-docs/dist/tags/download/index.html index 04da4b5b61..2fe8452a2c 100644 --- a/packages/noco-docs/dist/tags/download/index.html +++ b/packages/noco-docs/dist/tags/download/index.html @@ -4,13 +4,13 @@ One doc tagged with "Download" | NocoDB - +

    One doc tagged with "Download"

    View All Tags

    Download

    NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/duplicate/index.html b/packages/noco-docs/dist/tags/duplicate/index.html index 12c804aa5d..7a39cc8338 100644 --- a/packages/noco-docs/dist/tags/duplicate/index.html +++ b/packages/noco-docs/dist/tags/duplicate/index.html @@ -4,13 +4,13 @@ 6 docs tagged with "Duplicate" | NocoDB - +

    6 docs tagged with "Duplicate"

    View All Tags

    Actions on base

    Actions you can perform on a base in NocoDB: Rename, duplicate, delete, star a base.

    Actions on field

    This article explains how to perform various actions on a field- like rename, change field type, default, field width, record height, show/hide.

    Actions on record

    Learn how to perform actions (edit, duplicate, delete, etc) on a record in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/edit/index.html b/packages/noco-docs/dist/tags/edit/index.html index a674e4f348..65a7c36801 100644 --- a/packages/noco-docs/dist/tags/edit/index.html +++ b/packages/noco-docs/dist/tags/edit/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "Edit" | NocoDB - +

    2 docs tagged with "Edit"

    View All Tags

    Actions on record

    Learn how to perform actions (edit, duplicate, delete, etc) on a record in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/email/index.html b/packages/noco-docs/dist/tags/email/index.html index 9f736ced3e..38698db4c2 100644 --- a/packages/noco-docs/dist/tags/email/index.html +++ b/packages/noco-docs/dist/tags/email/index.html @@ -4,13 +4,13 @@ One doc tagged with "Email" | NocoDB - +

    One doc tagged with "Email"

    View All Tags

    Email

    This article explains how to create & work with an Email field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/enable/index.html b/packages/noco-docs/dist/tags/enable/index.html index 376af3caa2..17668b5a74 100644 --- a/packages/noco-docs/dist/tags/enable/index.html +++ b/packages/noco-docs/dist/tags/enable/index.html @@ -4,13 +4,13 @@ One doc tagged with "Enable" | NocoDB - +

    One doc tagged with "Enable"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/engineering/index.html b/packages/noco-docs/dist/tags/engineering/index.html index 8078fd720b..bde211d16d 100644 --- a/packages/noco-docs/dist/tags/engineering/index.html +++ b/packages/noco-docs/dist/tags/engineering/index.html @@ -4,13 +4,13 @@ 8 docs tagged with "Engineering" | NocoDB - +

    8 docs tagged with "Engineering"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/excel/index.html b/packages/noco-docs/dist/tags/excel/index.html index 2d8a8ad9c6..fa789244ba 100644 --- a/packages/noco-docs/dist/tags/excel/index.html +++ b/packages/noco-docs/dist/tags/excel/index.html @@ -4,13 +4,13 @@ 3 docs tagged with "Excel" | NocoDB - +

    3 docs tagged with "Excel"

    View All Tags

    Download

    NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/expanded-record/index.html b/packages/noco-docs/dist/tags/expanded-record/index.html index 80fbcdbd2c..f64055ceea 100644 --- a/packages/noco-docs/dist/tags/expanded-record/index.html +++ b/packages/noco-docs/dist/tags/expanded-record/index.html @@ -4,13 +4,13 @@ One doc tagged with "Expanded record" | NocoDB - +

    One doc tagged with "Expanded record"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/external/index.html b/packages/noco-docs/dist/tags/external/index.html index 004348c7cd..d37880955f 100644 --- a/packages/noco-docs/dist/tags/external/index.html +++ b/packages/noco-docs/dist/tags/external/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "External" | NocoDB - +

    2 docs tagged with "External"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/field-types/index.html b/packages/noco-docs/dist/tags/field-types/index.html index b854a18353..fb00451f2f 100644 --- a/packages/noco-docs/dist/tags/field-types/index.html +++ b/packages/noco-docs/dist/tags/field-types/index.html @@ -4,13 +4,13 @@ 32 docs tagged with "Field types" | NocoDB - +

    32 docs tagged with "Field types"

    View All Tags

    Attachment

    This article explains how to create & work with an Attachment field.

    Barcode

    This article explains how to create & work with a Barcode field.

    Checkbox

    This article explains how to create & work with a Checkbox field.

    Currency

    This article explains how to create & work with a Currency field.

    Date

    This article explains how to create & work with a Date field.

    Date functions

    This article explains various date functions that can be used in formula fields.

    Date Time

    This article explains how to create & work with a Date Time field.

    Decimal

    This article explains how to create & work with a Decimal field.

    Duration

    This article explains how to create & work with a Duration field.

    Email

    This article explains how to create & work with an Email field.

    Formula

    This article explains how to create & work with a Formula field.

    Geometry

    This article explains how to create & work with a Geometry field.

    JSON

    JSON is a custom field type that allows you to store JSON data in a field. Useful for storing data that can be represented as a JSON object, like API Response, or a set of key-value pairs.

    Links

    This article explains how to create & work with a Links field.

    Long text

    This article explains how to create & work with a Long text field.

    Lookup

    This article explains how to create & work with a Lookup field.

    Multi Select

    This article explains how to create & work with a Multi select field.

    Number

    This article explains how to create & work with a Number field.

    Numeric functions

    This article explains various numeric functions that can be used in formula fields.

    Percent

    This article explains how to create & work with a Percent field.

    Phone Number

    This article explains how to create & work with a Phone number field.

    QR code

    This article explains how to create & work with a QR code field.

    Rating

    This article explains how to create & work with a Rating field.

    Rollup

    This article explains how to create & work with a Rollup field.

    Single line text

    This article explains how to create & work with a Single line text field.

    Single Select

    This article explains how to create & work with a Single select field.

    Specific DB type

    This article explains how to create & work with a Specific DB Type field.

    String functions

    This article explains various string functions that can be used in formula fields.

    Time

    This article explains how to create & work with a Time field.

    URL

    This article explains how to create & work with an URL field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/field-width/index.html b/packages/noco-docs/dist/tags/field-width/index.html index d27fb9ff47..bba2aedda4 100644 --- a/packages/noco-docs/dist/tags/field-width/index.html +++ b/packages/noco-docs/dist/tags/field-width/index.html @@ -4,13 +4,13 @@ One doc tagged with "Field Width" | NocoDB - +

    One doc tagged with "Field Width"

    View All Tags

    Actions on field

    This article explains how to perform various actions on a field- like rename, change field type, default, field width, record height, show/hide.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/fields/index.html b/packages/noco-docs/dist/tags/fields/index.html index ad4ce14cee..120a833e4a 100644 --- a/packages/noco-docs/dist/tags/fields/index.html +++ b/packages/noco-docs/dist/tags/fields/index.html @@ -4,13 +4,13 @@ 37 docs tagged with "Fields" | NocoDB - +

    37 docs tagged with "Fields"

    View All Tags

    Actions on field

    This article explains how to perform various actions on a field- like rename, change field type, default, field width, record height, show/hide.

    Attachment

    This article explains how to create & work with an Attachment field.

    Barcode

    This article explains how to create & work with a Barcode field.

    Checkbox

    This article explains how to create & work with a Checkbox field.

    Currency

    This article explains how to create & work with a Currency field.

    Date

    This article explains how to create & work with a Date field.

    Date functions

    This article explains various date functions that can be used in formula fields.

    Date Time

    This article explains how to create & work with a Date Time field.

    Decimal

    This article explains how to create & work with a Decimal field.

    Display value

    This article explains how to set display value for a table & its use.

    Duration

    This article explains how to create & work with a Duration field.

    Email

    This article explains how to create & work with an Email field.

    Fields overview

    This article discusses various field types that NocoDB offers.

    Formula

    This article explains how to create & work with a Formula field.

    Geometry

    This article explains how to create & work with a Geometry field.

    JSON

    JSON is a custom field type that allows you to store JSON data in a field. Useful for storing data that can be represented as a JSON object, like API Response, or a set of key-value pairs.

    Links

    This article explains how to create & work with a Links field.

    Long text

    This article explains how to create & work with a Long text field.

    Lookup

    This article explains how to create & work with a Lookup field.

    Multi Select

    This article explains how to create & work with a Multi select field.

    Number

    This article explains how to create & work with a Number field.

    Numeric functions

    This article explains various numeric functions that can be used in formula fields.

    Percent

    This article explains how to create & work with a Percent field.

    Phone Number

    This article explains how to create & work with a Phone number field.

    Primary key

    This article explains what a primary key is and how it is used in NocoDB.

    QR code

    This article explains how to create & work with a QR code field.

    Rating

    This article explains how to create & work with a Rating field.

    Rollup

    This article explains how to create & work with a Rollup field.

    Single line text

    This article explains how to create & work with a Single line text field.

    Single Select

    This article explains how to create & work with a Single select field.

    Specific DB type

    This article explains how to create & work with a Specific DB Type field.

    String functions

    This article explains various string functions that can be used in formula fields.

    Time

    This article explains how to create & work with a Time field.

    URL

    This article explains how to create & work with an URL field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/filter/index.html b/packages/noco-docs/dist/tags/filter/index.html index f702c41c21..3e6caf22d2 100644 --- a/packages/noco-docs/dist/tags/filter/index.html +++ b/packages/noco-docs/dist/tags/filter/index.html @@ -4,13 +4,13 @@ One doc tagged with "Filter" | NocoDB - +

    One doc tagged with "Filter"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/form-view/index.html b/packages/noco-docs/dist/tags/form-view/index.html index 2000ecf13f..152327d9f6 100644 --- a/packages/noco-docs/dist/tags/form-view/index.html +++ b/packages/noco-docs/dist/tags/form-view/index.html @@ -4,13 +4,13 @@ 5 docs tagged with "Form view" | NocoDB - +

    5 docs tagged with "Form view"

    View All Tags

    Form

    Learn how to create, import, and manage forms in NocoDB.

    Share view

    Learn how to share a view publicly in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/formula/index.html b/packages/noco-docs/dist/tags/formula/index.html index 7409b2f783..5331d2851b 100644 --- a/packages/noco-docs/dist/tags/formula/index.html +++ b/packages/noco-docs/dist/tags/formula/index.html @@ -4,13 +4,13 @@ 6 docs tagged with "Formula" | NocoDB - +

    6 docs tagged with "Formula"

    View All Tags

    Date functions

    This article explains various date functions that can be used in formula fields.

    Formula

    This article explains how to create & work with a Formula field.

    Numeric functions

    This article explains various numeric functions that can be used in formula fields.

    String functions

    This article explains various string functions that can be used in formula fields.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/gallery-view/index.html b/packages/noco-docs/dist/tags/gallery-view/index.html index cc3078793c..fff036979f 100644 --- a/packages/noco-docs/dist/tags/gallery-view/index.html +++ b/packages/noco-docs/dist/tags/gallery-view/index.html @@ -4,13 +4,13 @@ 10 docs tagged with "Gallery view" | NocoDB - +

    10 docs tagged with "Gallery view"

    View All Tags

    Download

    NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.

    Gallery

    Learn how to work with gallery view in NocoDB.

    Search

    Learn how to search for records in NocoDB.

    Share view

    Learn how to share a view publicly in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/geometry/index.html b/packages/noco-docs/dist/tags/geometry/index.html index 2efbac2fbd..1d3ca549c5 100644 --- a/packages/noco-docs/dist/tags/geometry/index.html +++ b/packages/noco-docs/dist/tags/geometry/index.html @@ -4,13 +4,13 @@ One doc tagged with "Geometry" | NocoDB - +

    One doc tagged with "Geometry"

    View All Tags

    Geometry

    This article explains how to create & work with a Geometry field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/getting-started/index.html b/packages/noco-docs/dist/tags/getting-started/index.html index 7903a1efae..cb1418cd72 100644 --- a/packages/noco-docs/dist/tags/getting-started/index.html +++ b/packages/noco-docs/dist/tags/getting-started/index.html @@ -4,13 +4,13 @@ One doc tagged with "Getting Started" | NocoDB - +

    One doc tagged with "Getting Started"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/grid-view/index.html b/packages/noco-docs/dist/tags/grid-view/index.html index 6003249adf..abbe81e05d 100644 --- a/packages/noco-docs/dist/tags/grid-view/index.html +++ b/packages/noco-docs/dist/tags/grid-view/index.html @@ -4,13 +4,13 @@ 12 docs tagged with "Grid view" | NocoDB - +

    12 docs tagged with "Grid view"

    View All Tags

    Download

    NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.

    Grid

    Learn how to work with grid view in NocoDB.

    Record height

    Learn how to adjust the height of records in NocoDB.

    Search

    Learn how to search for records in NocoDB.

    Share view

    Learn how to share a view publicly in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/group-by/index.html b/packages/noco-docs/dist/tags/group-by/index.html index d5eb61e951..19f67f79db 100644 --- a/packages/noco-docs/dist/tags/group-by/index.html +++ b/packages/noco-docs/dist/tags/group-by/index.html @@ -4,13 +4,13 @@ One doc tagged with "Group by" | NocoDB - +

    One doc tagged with "Group by"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/hide/index.html b/packages/noco-docs/dist/tags/hide/index.html index 787442b166..0537db10c6 100644 --- a/packages/noco-docs/dist/tags/hide/index.html +++ b/packages/noco-docs/dist/tags/hide/index.html @@ -4,13 +4,13 @@ One doc tagged with "Hide" | NocoDB - +

    One doc tagged with "Hide"

    View All Tags

    Actions on field

    This article explains how to perform various actions on a field- like rename, change field type, default, field width, record height, show/hide.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/import/index.html b/packages/noco-docs/dist/tags/import/index.html index f21d2e07ed..6cfbef1b04 100644 --- a/packages/noco-docs/dist/tags/import/index.html +++ b/packages/noco-docs/dist/tags/import/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "Import" | NocoDB - +

    2 docs tagged with "Import"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/index.html b/packages/noco-docs/dist/tags/index.html index a2bf612df2..8d55d2e33a 100644 --- a/packages/noco-docs/dist/tags/index.html +++ b/packages/noco-docs/dist/tags/index.html @@ -4,13 +4,13 @@ Tags | NocoDB - +

    Tags

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/invite/index.html b/packages/noco-docs/dist/tags/invite/index.html index fadbeb2707..de214a3c3f 100644 --- a/packages/noco-docs/dist/tags/invite/index.html +++ b/packages/noco-docs/dist/tags/invite/index.html @@ -4,13 +4,13 @@ 4 docs tagged with "Invite" | NocoDB - +

    4 docs tagged with "Invite"

    View All Tags

    Workspace collaboration

    This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.

    Workspace collaboration

    This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/json/index.html b/packages/noco-docs/dist/tags/json/index.html index 1ca2c217d6..4f71db9639 100644 --- a/packages/noco-docs/dist/tags/json/index.html +++ b/packages/noco-docs/dist/tags/json/index.html @@ -4,13 +4,13 @@ 4 docs tagged with "JSON" | NocoDB - +

    4 docs tagged with "JSON"

    View All Tags

    Download

    NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.

    JSON

    JSON is a custom field type that allows you to store JSON data in a field. Useful for storing data that can be represented as a JSON object, like API Response, or a set of key-value pairs.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/kanban-view/index.html b/packages/noco-docs/dist/tags/kanban-view/index.html index 81da7f9f51..9a62f966d9 100644 --- a/packages/noco-docs/dist/tags/kanban-view/index.html +++ b/packages/noco-docs/dist/tags/kanban-view/index.html @@ -4,13 +4,13 @@ 10 docs tagged with "Kanban view" | NocoDB - +

    10 docs tagged with "Kanban view"

    View All Tags

    Download

    NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.

    Kanban

    Learn how to work with kanban view in NocoDB.

    Search

    Learn how to search for records in NocoDB.

    Share view

    Learn how to share a view publicly in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/links-based-types/index.html b/packages/noco-docs/dist/tags/links-based-types/index.html index 92e4c8cdc3..6201b0884e 100644 --- a/packages/noco-docs/dist/tags/links-based-types/index.html +++ b/packages/noco-docs/dist/tags/links-based-types/index.html @@ -4,13 +4,13 @@ 3 docs tagged with "Links based types" | NocoDB - +

    3 docs tagged with "Links based types"

    View All Tags

    Links

    This article explains how to create & work with a Links field.

    Lookup

    This article explains how to create & work with a Lookup field.

    Rollup

    This article explains how to create & work with a Rollup field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/links/index.html b/packages/noco-docs/dist/tags/links/index.html index e72c04e0ed..fa6519432f 100644 --- a/packages/noco-docs/dist/tags/links/index.html +++ b/packages/noco-docs/dist/tags/links/index.html @@ -4,13 +4,13 @@ One doc tagged with "Links" | NocoDB - +

    One doc tagged with "Links"

    View All Tags

    Links

    This article explains how to create & work with a Links field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/long-text/index.html b/packages/noco-docs/dist/tags/long-text/index.html index 7925c89a26..b0a7e6ca15 100644 --- a/packages/noco-docs/dist/tags/long-text/index.html +++ b/packages/noco-docs/dist/tags/long-text/index.html @@ -4,13 +4,13 @@ One doc tagged with "Long text" | NocoDB - +

    One doc tagged with "Long text"

    View All Tags

    Long text

    This article explains how to create & work with a Long text field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/lookup/index.html b/packages/noco-docs/dist/tags/lookup/index.html index 6cd202a45a..4336f11347 100644 --- a/packages/noco-docs/dist/tags/lookup/index.html +++ b/packages/noco-docs/dist/tags/lookup/index.html @@ -4,13 +4,13 @@ One doc tagged with "Lookup" | NocoDB - +

    One doc tagged with "Lookup"

    View All Tags

    Lookup

    This article explains how to create & work with a Lookup field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/member/index.html b/packages/noco-docs/dist/tags/member/index.html index b8abd249c9..7b25525b14 100644 --- a/packages/noco-docs/dist/tags/member/index.html +++ b/packages/noco-docs/dist/tags/member/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "Member" | NocoDB - +

    2 docs tagged with "Member"

    View All Tags

    Profile page

    This article explains how to manage your profile page.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/members/index.html b/packages/noco-docs/dist/tags/members/index.html index 74410cb29a..55081e4779 100644 --- a/packages/noco-docs/dist/tags/members/index.html +++ b/packages/noco-docs/dist/tags/members/index.html @@ -4,13 +4,13 @@ 4 docs tagged with "Members" | NocoDB - +

    4 docs tagged with "Members"

    View All Tags

    Workspace collaboration

    This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.

    Workspace collaboration

    This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/multi-fields-editor/index.html b/packages/noco-docs/dist/tags/multi-fields-editor/index.html index c1ff19b2e5..3918989dd4 100644 --- a/packages/noco-docs/dist/tags/multi-fields-editor/index.html +++ b/packages/noco-docs/dist/tags/multi-fields-editor/index.html @@ -4,13 +4,13 @@ One doc tagged with "Multi-fields editor" | NocoDB - +

    One doc tagged with "Multi-fields editor"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/multi-select/index.html b/packages/noco-docs/dist/tags/multi-select/index.html index 3d0c00670a..86f3df730f 100644 --- a/packages/noco-docs/dist/tags/multi-select/index.html +++ b/packages/noco-docs/dist/tags/multi-select/index.html @@ -4,13 +4,13 @@ One doc tagged with "Multi select" | NocoDB - +

    One doc tagged with "Multi select"

    View All Tags

    Multi Select

    This article explains how to create & work with a Multi select field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/my-sql/index.html b/packages/noco-docs/dist/tags/my-sql/index.html index 22bab5ee6a..aaa952b380 100644 --- a/packages/noco-docs/dist/tags/my-sql/index.html +++ b/packages/noco-docs/dist/tags/my-sql/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "MySQL" | NocoDB - +

    2 docs tagged with "MySQL"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/number/index.html b/packages/noco-docs/dist/tags/number/index.html index 8de47cccd5..f4752f89e9 100644 --- a/packages/noco-docs/dist/tags/number/index.html +++ b/packages/noco-docs/dist/tags/number/index.html @@ -4,13 +4,13 @@ One doc tagged with "Number" | NocoDB - +

    One doc tagged with "Number"

    View All Tags

    Number

    This article explains how to create & work with a Number field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/numerical-types/index.html b/packages/noco-docs/dist/tags/numerical-types/index.html index bd9c5b3a28..c64a153da4 100644 --- a/packages/noco-docs/dist/tags/numerical-types/index.html +++ b/packages/noco-docs/dist/tags/numerical-types/index.html @@ -4,13 +4,13 @@ 4 docs tagged with "Numerical types" | NocoDB - +

    4 docs tagged with "Numerical types"

    View All Tags

    Currency

    This article explains how to create & work with a Currency field.

    Decimal

    This article explains how to create & work with a Decimal field.

    Number

    This article explains how to create & work with a Number field.

    Percent

    This article explains how to create & work with a Percent field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/open-source/index.html b/packages/noco-docs/dist/tags/open-source/index.html index 4bc1006414..8d65354464 100644 --- a/packages/noco-docs/dist/tags/open-source/index.html +++ b/packages/noco-docs/dist/tags/open-source/index.html @@ -4,13 +4,13 @@ 5 docs tagged with "Open Source" | NocoDB - +

    5 docs tagged with "Open Source"

    View All Tags

    In Open Source

    This article explains Account settings specifics in Open source NocoDB.

    In Open Source

    This article explains specifics of User management in OSS.

    Installation

    Simple installation - takes about three minutes!

    Upgrading

    Upgrading NocoDB : Docker, Node and Homebrew!

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/overview/index.html b/packages/noco-docs/dist/tags/overview/index.html index 76ca1f9cf2..914915dbd0 100644 --- a/packages/noco-docs/dist/tags/overview/index.html +++ b/packages/noco-docs/dist/tags/overview/index.html @@ -4,13 +4,13 @@ 12 docs tagged with "Overview" | NocoDB - +

    12 docs tagged with "Overview"

    View All Tags

    Base overview

    This article explains the concept of bases in NocoDB.

    Fields overview

    This article discusses various field types that NocoDB offers.

    Table overview

    Learn how to create, import, and manage tables in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/percent/index.html b/packages/noco-docs/dist/tags/percent/index.html index 3e087854c0..6017903b39 100644 --- a/packages/noco-docs/dist/tags/percent/index.html +++ b/packages/noco-docs/dist/tags/percent/index.html @@ -4,13 +4,13 @@ One doc tagged with "Percent" | NocoDB - +

    One doc tagged with "Percent"

    View All Tags

    Percent

    This article explains how to create & work with a Percent field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/permissions/index.html b/packages/noco-docs/dist/tags/permissions/index.html index eb03be9408..60c94f65a8 100644 --- a/packages/noco-docs/dist/tags/permissions/index.html +++ b/packages/noco-docs/dist/tags/permissions/index.html @@ -4,13 +4,13 @@ 3 docs tagged with "Permissions" | NocoDB - +

    3 docs tagged with "Permissions"

    View All Tags

    Workspace collaboration

    This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/pg/index.html b/packages/noco-docs/dist/tags/pg/index.html index c97d536133..9a521c3beb 100644 --- a/packages/noco-docs/dist/tags/pg/index.html +++ b/packages/noco-docs/dist/tags/pg/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "PG" | NocoDB - +

    2 docs tagged with "PG"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/phone-number/index.html b/packages/noco-docs/dist/tags/phone-number/index.html index 8b6b61efc5..fab1b7ef37 100644 --- a/packages/noco-docs/dist/tags/phone-number/index.html +++ b/packages/noco-docs/dist/tags/phone-number/index.html @@ -4,13 +4,13 @@ One doc tagged with "Phone number" | NocoDB - +

    One doc tagged with "Phone number"

    View All Tags

    Phone Number

    This article explains how to create & work with a Phone number field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/primary-key/index.html b/packages/noco-docs/dist/tags/primary-key/index.html index 7a4bba2846..813dd558da 100644 --- a/packages/noco-docs/dist/tags/primary-key/index.html +++ b/packages/noco-docs/dist/tags/primary-key/index.html @@ -4,13 +4,13 @@ One doc tagged with "Primary Key" | NocoDB - +

    One doc tagged with "Primary Key"

    View All Tags

    Primary key

    This article explains what a primary key is and how it is used in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/productivity-hacks/index.html b/packages/noco-docs/dist/tags/productivity-hacks/index.html index 560ea3e409..ba97037895 100644 --- a/packages/noco-docs/dist/tags/productivity-hacks/index.html +++ b/packages/noco-docs/dist/tags/productivity-hacks/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "Productivity hacks" | NocoDB - +

    2 docs tagged with "Productivity hacks"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/profile/index.html b/packages/noco-docs/dist/tags/profile/index.html index 1e2802e1f3..40bb9344ce 100644 --- a/packages/noco-docs/dist/tags/profile/index.html +++ b/packages/noco-docs/dist/tags/profile/index.html @@ -4,13 +4,13 @@ One doc tagged with "Profile" | NocoDB - +

    One doc tagged with "Profile"

    View All Tags

    Profile page

    This article explains how to manage your profile page.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/qr-code/index.html b/packages/noco-docs/dist/tags/qr-code/index.html index 3b96a7a00c..a795459a12 100644 --- a/packages/noco-docs/dist/tags/qr-code/index.html +++ b/packages/noco-docs/dist/tags/qr-code/index.html @@ -4,13 +4,13 @@ One doc tagged with "QR code" | NocoDB - +

    One doc tagged with "QR code"

    View All Tags

    QR code

    This article explains how to create & work with a QR code field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/rating/index.html b/packages/noco-docs/dist/tags/rating/index.html index cf3c872233..25fc2a377c 100644 --- a/packages/noco-docs/dist/tags/rating/index.html +++ b/packages/noco-docs/dist/tags/rating/index.html @@ -4,13 +4,13 @@ One doc tagged with "Rating" | NocoDB - +

    One doc tagged with "Rating"

    View All Tags

    Rating

    This article explains how to create & work with a Rating field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/record-height/index.html b/packages/noco-docs/dist/tags/record-height/index.html index 8ccec81784..ffa0b9e5a2 100644 --- a/packages/noco-docs/dist/tags/record-height/index.html +++ b/packages/noco-docs/dist/tags/record-height/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "Record Height" | NocoDB - +

    2 docs tagged with "Record Height"

    View All Tags

    Actions on field

    This article explains how to perform various actions on a field- like rename, change field type, default, field width, record height, show/hide.

    Record height

    Learn how to adjust the height of records in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/records/index.html b/packages/noco-docs/dist/tags/records/index.html index 6494a88c81..6334ec2bf9 100644 --- a/packages/noco-docs/dist/tags/records/index.html +++ b/packages/noco-docs/dist/tags/records/index.html @@ -4,13 +4,13 @@ 4 docs tagged with "Records" | NocoDB - +

    4 docs tagged with "Records"

    View All Tags

    Actions on record

    Learn how to perform actions (edit, duplicate, delete, etc) on a record in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/relations/index.html b/packages/noco-docs/dist/tags/relations/index.html index 7c8df534cb..43a017fcf3 100644 --- a/packages/noco-docs/dist/tags/relations/index.html +++ b/packages/noco-docs/dist/tags/relations/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "Relations" | NocoDB - +

    2 docs tagged with "Relations"

    View All Tags

    Actions on base

    Actions you can perform on a base in NocoDB: Rename, duplicate, delete, star a base.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/remove/index.html b/packages/noco-docs/dist/tags/remove/index.html index 87b0b40dc2..a496847d36 100644 --- a/packages/noco-docs/dist/tags/remove/index.html +++ b/packages/noco-docs/dist/tags/remove/index.html @@ -4,13 +4,13 @@ One doc tagged with "Remove" | NocoDB - +

    One doc tagged with "Remove"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/rename/index.html b/packages/noco-docs/dist/tags/rename/index.html index 1b49c4f9c1..285c500500 100644 --- a/packages/noco-docs/dist/tags/rename/index.html +++ b/packages/noco-docs/dist/tags/rename/index.html @@ -4,13 +4,13 @@ 5 docs tagged with "Rename" | NocoDB - +

    5 docs tagged with "Rename"

    View All Tags

    Actions on base

    Actions you can perform on a base in NocoDB: Rename, duplicate, delete, star a base.

    Actions on field

    This article explains how to perform various actions on a field- like rename, change field type, default, field width, record height, show/hide.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/reorder/index.html b/packages/noco-docs/dist/tags/reorder/index.html index 360e4afbe8..b028bea7b8 100644 --- a/packages/noco-docs/dist/tags/reorder/index.html +++ b/packages/noco-docs/dist/tags/reorder/index.html @@ -4,13 +4,13 @@ One doc tagged with "Reorder" | NocoDB - +

    One doc tagged with "Reorder"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/rest-ap-is/index.html b/packages/noco-docs/dist/tags/rest-ap-is/index.html index 67a5e7ac3f..c964d27c77 100644 --- a/packages/noco-docs/dist/tags/rest-ap-is/index.html +++ b/packages/noco-docs/dist/tags/rest-ap-is/index.html @@ -4,13 +4,13 @@ One doc tagged with "REST APIs" | NocoDB - +

    One doc tagged with "REST APIs"

    View All Tags

    Actions on base

    Actions you can perform on a base in NocoDB: Rename, duplicate, delete, star a base.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/roles/index.html b/packages/noco-docs/dist/tags/roles/index.html index 3655a2d034..4d60603d8d 100644 --- a/packages/noco-docs/dist/tags/roles/index.html +++ b/packages/noco-docs/dist/tags/roles/index.html @@ -4,13 +4,13 @@ 5 docs tagged with "Roles" | NocoDB - +

    5 docs tagged with "Roles"

    View All Tags

    Workspace collaboration

    This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.

    Workspace collaboration

    This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/rollup/index.html b/packages/noco-docs/dist/tags/rollup/index.html index dab4579a3d..73c770aa0f 100644 --- a/packages/noco-docs/dist/tags/rollup/index.html +++ b/packages/noco-docs/dist/tags/rollup/index.html @@ -4,13 +4,13 @@ One doc tagged with "Rollup" | NocoDB - +

    One doc tagged with "Rollup"

    View All Tags

    Rollup

    This article explains how to create & work with a Rollup field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/search/index.html b/packages/noco-docs/dist/tags/search/index.html index b81c9868f3..3482549000 100644 --- a/packages/noco-docs/dist/tags/search/index.html +++ b/packages/noco-docs/dist/tags/search/index.html @@ -4,13 +4,13 @@ One doc tagged with "Search" | NocoDB - +

    One doc tagged with "Search"

    View All Tags

    Search

    Learn how to search for records in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/select-based-types/index.html b/packages/noco-docs/dist/tags/select-based-types/index.html index 9a6598deb8..6045f1850b 100644 --- a/packages/noco-docs/dist/tags/select-based-types/index.html +++ b/packages/noco-docs/dist/tags/select-based-types/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "Select based types" | NocoDB - +

    2 docs tagged with "Select based types"

    View All Tags

    Multi Select

    This article explains how to create & work with a Multi select field.

    Single Select

    This article explains how to create & work with a Single select field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/share-base/index.html b/packages/noco-docs/dist/tags/share-base/index.html index 36331f2cd7..35c9551679 100644 --- a/packages/noco-docs/dist/tags/share-base/index.html +++ b/packages/noco-docs/dist/tags/share-base/index.html @@ -4,13 +4,13 @@ One doc tagged with "Share base" | NocoDB - +

    One doc tagged with "Share base"

    View All Tags

    Share base

    Procedures to share a base & generating embedded iframe

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/share/index.html b/packages/noco-docs/dist/tags/share/index.html index 19411b919f..4cb21cd28f 100644 --- a/packages/noco-docs/dist/tags/share/index.html +++ b/packages/noco-docs/dist/tags/share/index.html @@ -4,13 +4,13 @@ 5 docs tagged with "Share" | NocoDB - +

    5 docs tagged with "Share"

    View All Tags

    Share base

    Procedures to share a base & generating embedded iframe

    Share base

    Procedures to share a base publicly & generating embedded iframe

    Share view

    Learn how to share a view publicly in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/shortcuts/index.html b/packages/noco-docs/dist/tags/shortcuts/index.html index 65b8e20cb8..6e4349e96b 100644 --- a/packages/noco-docs/dist/tags/shortcuts/index.html +++ b/packages/noco-docs/dist/tags/shortcuts/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "Shortcuts" | NocoDB - +

    2 docs tagged with "Shortcuts"

    View All Tags

    Actions on record

    Learn how to perform actions (edit, duplicate, delete, etc) on a record in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/show-hide/index.html b/packages/noco-docs/dist/tags/show-hide/index.html index 5654c8088e..7b116e868d 100644 --- a/packages/noco-docs/dist/tags/show-hide/index.html +++ b/packages/noco-docs/dist/tags/show-hide/index.html @@ -4,13 +4,13 @@ One doc tagged with "Show/hide" | NocoDB - +

    One doc tagged with "Show/hide"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/single-line-text/index.html b/packages/noco-docs/dist/tags/single-line-text/index.html index 11aaafa813..e204dd2852 100644 --- a/packages/noco-docs/dist/tags/single-line-text/index.html +++ b/packages/noco-docs/dist/tags/single-line-text/index.html @@ -4,13 +4,13 @@ One doc tagged with "Single line text" | NocoDB - +

    One doc tagged with "Single line text"

    View All Tags

    Single line text

    This article explains how to create & work with a Single line text field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/single-select/index.html b/packages/noco-docs/dist/tags/single-select/index.html index b22d8bcbd7..c8eba86a28 100644 --- a/packages/noco-docs/dist/tags/single-select/index.html +++ b/packages/noco-docs/dist/tags/single-select/index.html @@ -4,13 +4,13 @@ One doc tagged with "Single select" | NocoDB - +

    One doc tagged with "Single select"

    View All Tags

    Single Select

    This article explains how to create & work with a Single select field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/sort/index.html b/packages/noco-docs/dist/tags/sort/index.html index 44e5f80e0c..08ccc056c7 100644 --- a/packages/noco-docs/dist/tags/sort/index.html +++ b/packages/noco-docs/dist/tags/sort/index.html @@ -4,13 +4,13 @@ 2 docs tagged with "Sort" | NocoDB - +

    2 docs tagged with "Sort"

    View All Tags

    Actions on field

    This article explains how to perform various actions on a field- like rename, change field type, default, field width, record height, show/hide.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/specific-db-type/index.html b/packages/noco-docs/dist/tags/specific-db-type/index.html index 88d2d3d14e..5b1229059a 100644 --- a/packages/noco-docs/dist/tags/specific-db-type/index.html +++ b/packages/noco-docs/dist/tags/specific-db-type/index.html @@ -4,13 +4,13 @@ One doc tagged with "Specific DB type" | NocoDB - +

    One doc tagged with "Specific DB type"

    View All Tags

    Specific DB type

    This article explains how to create & work with a Specific DB Type field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/swagger/index.html b/packages/noco-docs/dist/tags/swagger/index.html index 0c2cf64b5e..08ace33f85 100644 --- a/packages/noco-docs/dist/tags/swagger/index.html +++ b/packages/noco-docs/dist/tags/swagger/index.html @@ -4,13 +4,13 @@ One doc tagged with "Swagger" | NocoDB - +

    One doc tagged with "Swagger"

    View All Tags

    Actions on base

    Actions you can perform on a base in NocoDB: Rename, duplicate, delete, star a base.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/sync/index.html b/packages/noco-docs/dist/tags/sync/index.html index 68ddce4a20..653b089532 100644 --- a/packages/noco-docs/dist/tags/sync/index.html +++ b/packages/noco-docs/dist/tags/sync/index.html @@ -4,13 +4,13 @@ One doc tagged with "Sync" | NocoDB - +

    One doc tagged with "Sync"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/table-details/index.html b/packages/noco-docs/dist/tags/table-details/index.html index 9f72e87d21..59a4f90530 100644 --- a/packages/noco-docs/dist/tags/table-details/index.html +++ b/packages/noco-docs/dist/tags/table-details/index.html @@ -4,13 +4,13 @@ One doc tagged with "Table details" | NocoDB - +

    One doc tagged with "Table details"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/table-operations/index.html b/packages/noco-docs/dist/tags/table-operations/index.html index 56b0007197..fe1a7b6994 100644 --- a/packages/noco-docs/dist/tags/table-operations/index.html +++ b/packages/noco-docs/dist/tags/table-operations/index.html @@ -4,13 +4,13 @@ 8 docs tagged with "Table operations" | NocoDB - +

    8 docs tagged with "Table operations"

    View All Tags

    Download

    NocoDB offers users the ability to export data from the spreadsheet grid in a variety of formats. This feature is useful when working with large datasets and can be used in conjunction with the Filter and Sort feature to further refine your data.

    Record height

    Learn how to adjust the height of records in NocoDB.

    Search

    Learn how to search for records in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/table/index.html b/packages/noco-docs/dist/tags/table/index.html index 351813a338..c58f1debe9 100644 --- a/packages/noco-docs/dist/tags/table/index.html +++ b/packages/noco-docs/dist/tags/table/index.html @@ -4,13 +4,13 @@ One doc tagged with "Table" | NocoDB - +

    One doc tagged with "Table"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/tables/index.html b/packages/noco-docs/dist/tags/tables/index.html index 50811ee58a..87be46ac42 100644 --- a/packages/noco-docs/dist/tags/tables/index.html +++ b/packages/noco-docs/dist/tags/tables/index.html @@ -4,13 +4,13 @@ 5 docs tagged with "Tables" | NocoDB - +

    5 docs tagged with "Tables"

    View All Tags

    Table overview

    Learn how to create, import, and manage tables in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/text-based-types/index.html b/packages/noco-docs/dist/tags/text-based-types/index.html index 35d4248a65..79bb63dab5 100644 --- a/packages/noco-docs/dist/tags/text-based-types/index.html +++ b/packages/noco-docs/dist/tags/text-based-types/index.html @@ -4,13 +4,13 @@ 5 docs tagged with "Text based types" | NocoDB - +

    5 docs tagged with "Text based types"

    View All Tags

    Email

    This article explains how to create & work with an Email field.

    Long text

    This article explains how to create & work with a Long text field.

    Phone Number

    This article explains how to create & work with a Phone number field.

    Single line text

    This article explains how to create & work with a Single line text field.

    URL

    This article explains how to create & work with an URL field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/ui-acl/index.html b/packages/noco-docs/dist/tags/ui-acl/index.html index 70a98ecb6e..7a99c1b382 100644 --- a/packages/noco-docs/dist/tags/ui-acl/index.html +++ b/packages/noco-docs/dist/tags/ui-acl/index.html @@ -4,13 +4,13 @@ One doc tagged with "UI ACL" | NocoDB - +

    One doc tagged with "UI ACL"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/upload/index.html b/packages/noco-docs/dist/tags/upload/index.html index c175bbc1b4..e4e2a52521 100644 --- a/packages/noco-docs/dist/tags/upload/index.html +++ b/packages/noco-docs/dist/tags/upload/index.html @@ -4,13 +4,13 @@ One doc tagged with "Upload" | NocoDB - +

    One doc tagged with "Upload"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/url/index.html b/packages/noco-docs/dist/tags/url/index.html index 33c82034b4..f009a1b154 100644 --- a/packages/noco-docs/dist/tags/url/index.html +++ b/packages/noco-docs/dist/tags/url/index.html @@ -4,13 +4,13 @@ One doc tagged with "URL" | NocoDB - +

    One doc tagged with "URL"

    View All Tags

    URL

    This article explains how to create & work with an URL field.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/views/index.html b/packages/noco-docs/dist/tags/views/index.html index fd87591788..e311a90b30 100644 --- a/packages/noco-docs/dist/tags/views/index.html +++ b/packages/noco-docs/dist/tags/views/index.html @@ -4,13 +4,13 @@ 9 docs tagged with "Views" | NocoDB - +

    9 docs tagged with "Views"

    View All Tags

    Form

    Learn how to create, import, and manage forms in NocoDB.

    Gallery

    Learn how to work with gallery view in NocoDB.

    Grid

    Learn how to work with grid view in NocoDB.

    Kanban

    Learn how to work with kanban view in NocoDB.

    Share view

    Learn how to share a view publicly in NocoDB.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/visibility/index.html b/packages/noco-docs/dist/tags/visibility/index.html index 2d06503044..158bc62a3a 100644 --- a/packages/noco-docs/dist/tags/visibility/index.html +++ b/packages/noco-docs/dist/tags/visibility/index.html @@ -4,13 +4,13 @@ One doc tagged with "Visibility" | NocoDB - +

    One doc tagged with "Visibility"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/webhook/index.html b/packages/noco-docs/dist/tags/webhook/index.html index 7ab3bee557..995d378df5 100644 --- a/packages/noco-docs/dist/tags/webhook/index.html +++ b/packages/noco-docs/dist/tags/webhook/index.html @@ -4,13 +4,13 @@ 3 docs tagged with "Webhook" | NocoDB - +

    3 docs tagged with "Webhook"

    View All Tags
    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/tags/workspaces/index.html b/packages/noco-docs/dist/tags/workspaces/index.html index 28f09aa86c..057739ed13 100644 --- a/packages/noco-docs/dist/tags/workspaces/index.html +++ b/packages/noco-docs/dist/tags/workspaces/index.html @@ -4,13 +4,13 @@ 6 docs tagged with "Workspaces" | NocoDB - +

    6 docs tagged with "Workspaces"

    View All Tags

    Workspace collaboration

    This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.

    Workspace collaboration

    This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/views/actions-on-view/index.html b/packages/noco-docs/dist/views/actions-on-view/index.html index dab5be55c7..eb0fa388fa 100644 --- a/packages/noco-docs/dist/views/actions-on-view/index.html +++ b/packages/noco-docs/dist/views/actions-on-view/index.html @@ -4,15 +4,15 @@ Actions on view | NocoDB - +
    -
    Version: Latest

    Actions on view

    View context menu​

    The view context menu provides a set of tools to interact with the view. The view context menu can be accessed by clicking on the ellipsis symbol (...) located next to view in the left sidebar.

    image

    Rename view​

    1. Click on the ellipsis symbol (...) next to view name located in the left sidebar.
    2. Click on the Rename option from the view context menu.
    3. Enter the desired new view name into the provided field.
    4. Use Enter key to finalize the renaming process.

    image

    Change view icon​

    1. Click on the existing view icon to the left of the view name in the left sidebar.
    2. Select the desired icon from the list of available options.

    image

    Duplicate view​

    1. Click on the ellipsis symbol (...) next to view name located in the left sidebar.
    2. Click on the Duplicate option from the view context menu.
    3. Enter the desired new view name into the provided field.
    4. Click on the Duplicate View button in the confirmation dialog.

    image +

    Version: Latest

    Actions on view

    View context menu​

    The view context menu provides a set of tools to interact with the view. The view context menu can be accessed by clicking on the ellipsis symbol (...) located next to view in the left sidebar.

    image

    Rename view​

    1. Click on the ellipsis symbol (...) next to view name located in the left sidebar.
    2. Click on the Rename option from the view context menu.
    3. Enter the desired new view name into the provided field.
    4. Use Enter key to finalize the renaming process.

    image

    Change view icon​

    1. Click on the existing view icon to the left of the view name in the left sidebar.
    2. Select the desired icon from the list of available options.

    image

    Duplicate view​

    1. Click on the ellipsis symbol (...) next to view name located in the left sidebar.
    2. Click on the Duplicate option from the view context menu.
    3. Enter the desired new view name into the provided field.
    4. Click on the Duplicate View button in the confirmation dialog.

    image image

    Delete view​

    danger

    This action cannot be undone.

    1. Click on the ellipsis symbol (...) next to view name located in the left sidebar.
    2. Click on the Delete option from the view context menu.
    3. Click on the Delete View button in the confirmation dialog.

    image image

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/views/create-view/index.html b/packages/noco-docs/dist/views/create-view/index.html index cd97dba1b1..2e5af89210 100644 --- a/packages/noco-docs/dist/views/create-view/index.html +++ b/packages/noco-docs/dist/views/create-view/index.html @@ -4,14 +4,14 @@ Create view | NocoDB - +
    -
    Version: Latest

    Create view

    Create new view​

    1. Click on + on the left sidebar next to table name OR click on + New View button below table name.
    2. Select view type from the dropdown modal.
    3. Fill view name in the pop-up modal.
      • For Kanban view, select the Single select field to be used as the Kanban field.
    4. Click on Create View button.

    image +

    Version: Latest

    Create view

    Create new view​

    1. Click on + on the left sidebar next to table name OR click on + New View button below table name.
    2. Select view type from the dropdown modal.
    3. Fill view name in the pop-up modal.
      • For Kanban view, select the Single select field to be used as the Kanban field.
    4. Click on Create View button.

    image image

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/views/share-view/index.html b/packages/noco-docs/dist/views/share-view/index.html index c79c2b4763..3f67e684ba 100644 --- a/packages/noco-docs/dist/views/share-view/index.html +++ b/packages/noco-docs/dist/views/share-view/index.html @@ -4,16 +4,16 @@ Share view | NocoDB - +
    -
    Version: Latest

    Share view

    Sharing a specific view of a table becomes highly valuable when you need to collaborate with individuals outside your organization who need access to specific sections of your database. This shared view provides a read-only perspective, accessible to anyone, regardless of their workspace affiliation. You have control over which data fields and records are visible to these external viewers, ensuring that any sensitive data remains hidden. Furthermore, if you decide to make changes to the visible fields or records within the view, the shared link will promptly reflect these adjustments, updating in real-time.

    Generate Share View​

    1. Click Share button on the top right of the toolbar
    2. Toggle Enable public viewing to create shared view link
    3. Click Copy button to copy the link to clipboard

    share button

    shared view

    Share view options​

    Password protection​

    You can enable Restrict access with a password if you want a password-protected view

    password protection

    Download options​

    You can toggle Allow Download button to enable or disable download CSV/XLSX options in the shared view link

    download options

    Share Form View Options​

    Form view has additional customizations for shared view. You can enable/disable the following options for shared form view:

    1. Survey mode: This option when enabled, will display the form in survey mode.
    2. RTL Orientation: This option when enabled, will display the form in RTL orientation.
    3. Themes: You can select a theme for the form from the dropdown. +
      Version: Latest

      Share view

      Sharing a specific view of a table becomes highly valuable when you need to collaborate with individuals outside your organization who need access to specific sections of your database. This shared view provides a read-only perspective, accessible to anyone, regardless of their workspace affiliation. You have control over which data fields and records are visible to these external viewers, ensuring that any sensitive data remains hidden. Furthermore, if you decide to make changes to the visible fields or records within the view, the shared link will promptly reflect these adjustments, updating in real-time.

      Generate Share View​

      1. Click Share button on the top right of the toolbar
      2. Toggle Enable public viewing to create shared view link
      3. Click Copy button to copy the link to clipboard

      share button

      shared view

      Share view options​

      Password protection​

      You can enable Restrict access with a password if you want a password-protected view

      password protection

      Download options​

      You can toggle Allow Download button to enable or disable download CSV/XLSX options in the shared view link

      download options

      Share Form View Options​

      Form view has additional customizations for shared view. You can enable/disable the following options for shared form view:

      1. Survey mode: This option when enabled, will display the form in survey mode.
      2. RTL Orientation: This option when enabled, will display the form in RTL orientation.
      3. Themes: You can select a theme for the form from the dropdown. form view options

      Access Share View​

      To access the shared view, please follow the steps below: Click on the Shared View URL. If the URL is password-protected, you will be prompted to enter the password to unlock it. Please input the required password to proceed.

      password modal

      Once the password is successfully entered and authenticated, you will gain access to the shared view. In the event that the URL is not password-protected, you will be directed to the shared view directly, without the need for a password.

      share-view

      Users with the shared view link can only view the data and cannot make any changes to the view or its content. Records and fields in the shared view will be updated in real-time as changes are made to the original view. Users accessing shared view can apply filters and sort records as per their requirements.

      info

      Note that, filters & sorts applied to shared view will not be persisted. These filters & sorts will be reset when the shared view is accessed again.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/views/view-types/form/index.html b/packages/noco-docs/dist/views/view-types/form/index.html index 24729dbfda..7449ce0451 100644 --- a/packages/noco-docs/dist/views/view-types/form/index.html +++ b/packages/noco-docs/dist/views/view-types/form/index.html @@ -4,15 +4,15 @@ Form | NocoDB - +
    -
    Version: Latest

    Form

    Form View allows you to arrange fields in a form to input data.

    1010-2 Form

    Form View Builder​

    Form view builder layout can be divided into 3 sections:

    1. Fields Area - This is the area where fields available in the tables that are not yet added to the form are listed.
    2. Form Area - This is the area where fields added to the form are listed.
    3. Form Settings - This is the area where you can configure the form view. This mainly consists of actions & customisations that can be performed after a form view is submitted.

    Form Builder

    Form View Actions​

    1. Create a New Form View
    2. Rename an Existing Form View
    3. Duplicate a Form View
    4. Remove a Form View
    5. Share a Form View
    6. Lock Form View for Edits

    Form View Operations​

    Add Form Title & Description​

    In the Form View area, click on in input boxes provided for Title <1> & Description <2> to add/update title & description to the form.

    Form Title &amp; Description

    Add Fields to the Form​

    To add a field to the form, either

    • Drag and drop the field from the Fields Area to the Form Area at required position
    • Click on the field in the Fields Area to add it to the end of the Form Area

    Change field label & help-text​

    To change the field label displayed on the form & add help-text, click on the field in the Form Area and update the values in the input boxes provided for Label <1> & Help Text <2>.

    Field Label &amp; Help Text

    Mark a Field as Required​

    To mark a field as required, click on the field in the Form Area and toggle the Required switch.

    Required Field

    Rearrange Fields Within the Form​

    To rearrange fields within the form, drag and drop the field to the required position.

    Remove Fields from the Form​

    To remove a field from the form, either

    • Drag and drop the field from the Form Area to the Fields Area
    • Hover over the field in the Form Area and click on the hide icon

    Hide Field

    Add a New Field to the Table​

    To add a new field to the table,

    • Click on the + Add new field to this table in the Fields Area and
    • Select the field name & type from the dropdown.
    • Click on Save Field

    Add Field

    Form View Settings​

    NocoDB allows you to configure the form view to perform various actions after a form is submitted. These actions can be configured in the Form Settings area.

    1. After Submit Message: You can configure a message to display on successful submission of the form.
    2. Show Submit Another Form Button: This option when enabled, will display a Submit Another Form button after the form is submitted.
    3. Show a Blank form: This option when enabled, will display a new blank form 5 seconds after the form is submitted.
    4. Email me: Enable this option to receive an Email after the form is submitted.

    Form View Settings

    Survey Form View​

    NocoDB supports a special type of form view called Survey Form View. This view is ideal for creating surveys & questionnaires. This view can be enabled by toggling the Survey Mode switch when creating shared form view.

    When enabled,

    • Form input fields will be displayed one at a time.
    • Users can navigate between fields using the < & > buttons.

    Survey Form View

    Form View
    +

    Version: Latest

    Form

    Form View allows you to arrange fields in a form to input data.

    1010-2 Form

    Form View Builder​

    Form view builder layout can be divided into 3 sections:

    1. Fields Area - This is the area where fields available in the tables that are not yet added to the form are listed.
    2. Form Area - This is the area where fields added to the form are listed.
    3. Form Settings - This is the area where you can configure the form view. This mainly consists of actions & customisations that can be performed after a form view is submitted.

    Form Builder

    Form View Actions​

    1. Create a New Form View
    2. Rename an Existing Form View
    3. Duplicate a Form View
    4. Remove a Form View
    5. Share a Form View
    6. Lock Form View for Edits

    Form View Operations​

    Add Form Title & Description​

    In the Form View area, click on in input boxes provided for Title <1> & Description <2> to add/update title & description to the form.

    Form Title &amp; Description

    Add Fields to the Form​

    To add a field to the form, either

    • Drag and drop the field from the Fields Area to the Form Area at required position
    • Click on the field in the Fields Area to add it to the end of the Form Area

    Change field label & help-text​

    To change the field label displayed on the form & add help-text, click on the field in the Form Area and update the values in the input boxes provided for Label <1> & Help Text <2>.

    Field Label &amp; Help Text

    Mark a Field as Required​

    To mark a field as required, click on the field in the Form Area and toggle the Required switch.

    Required Field

    Rearrange Fields Within the Form​

    To rearrange fields within the form, drag and drop the field to the required position.

    Remove Fields from the Form​

    To remove a field from the form, either

    • Drag and drop the field from the Form Area to the Fields Area
    • Hover over the field in the Form Area and click on the hide icon

    Hide Field

    Add a New Field to the Table​

    To add a new field to the table,

    • Click on the + Add new field to this table in the Fields Area and
    • Select the field name & type from the dropdown.
    • Click on Save Field

    Add Field

    Form View Settings​

    NocoDB allows you to configure the form view to perform various actions after a form is submitted. These actions can be configured in the Form Settings area.

    1. After Submit Message: You can configure a message to display on successful submission of the form.
    2. Show Submit Another Form Button: This option when enabled, will display a Submit Another Form button after the form is submitted.
    3. Show a Blank form: This option when enabled, will display a new blank form 5 seconds after the form is submitted.
    4. Email me: Enable this option to receive an Email after the form is submitted.

    Form View Settings

    Survey Form View​

    NocoDB supports a special type of form view called Survey Form View. This view is ideal for creating surveys & questionnaires. This view can be enabled by toggling the Survey Mode switch when creating shared form view.

    When enabled,

    • Form input fields will be displayed one at a time.
    • Users can navigate between fields using the < & > buttons.

    Survey Form View

    Form View
    Gallery View
    Kanban View

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/views/view-types/gallery/index.html b/packages/noco-docs/dist/views/view-types/gallery/index.html index 16c2e223a4..a6e62293c0 100644 --- a/packages/noco-docs/dist/views/view-types/gallery/index.html +++ b/packages/noco-docs/dist/views/view-types/gallery/index.html @@ -4,15 +4,15 @@ Gallery | NocoDB - +
    -
    Version: Latest

    Gallery

    Gallery View allows you to display images as thumbnails with other fields just like a gallery. This view type is ideal for viewing images in a gallery-like interface. Like in Gallery, you can also perform various operations on the gallery view, such as sorting, filtering, grouping, and searching. You can also export the data in the gallery view to CSV or Excel format. This section will cover all the operations that can be performed on the gallery view.

    1010-2 Gallery

    1. Create a New Gallery View
    2. Rename an Existing Gallery View
    3. Duplicate a Gallery View
    4. Remove a Gallery View
    5. Share a Gallery View
    6. Lock Gallery View for Edits
    1. Rearrange Fields Within the Gallery
    2. Show or Hide Fields Within the Gallery
    3. Apply Filters to Display Specific Records on the Gallery
    4. Sort Records on the Gallery by One or More Criteria
    5. Perform Quick Searches for Specific Data Within Fields
    6. Export Data to CSV or Excel Format
    7. Change Cover Image
    1. Add a New Record to the Gallery: Currently it is not possible to insert a new record directly on the gallery view. However, you can add a new record to the table, and it will be displayed on the gallery view.
    2. Edit an Existing Record on the Gallery: Click on the card on the gallery view to open the record in the expanded record view. You can edit the record in the form view and save it.
    3. Delete a Single Record from the Gallery: Click on the card on the gallery view to open the record in the expanded record view. You can delete the record in the form view by using the expanded record context menu.
    4. Delete Multiple Records in Bulk from the Gallery: Currently it is not possible to delete multiple records in bulk directly on the gallery view. However, you can delete multiple records in bulk from the grid view & it will be reflected on the gallery view.

    Grid View
    +

    Version: Latest

    Gallery

    Gallery View allows you to display images as thumbnails with other fields just like a gallery. This view type is ideal for viewing images in a gallery-like interface. Like in Gallery, you can also perform various operations on the gallery view, such as sorting, filtering, grouping, and searching. You can also export the data in the gallery view to CSV or Excel format. This section will cover all the operations that can be performed on the gallery view.

    1010-2 Gallery

    1. Create a New Gallery View
    2. Rename an Existing Gallery View
    3. Duplicate a Gallery View
    4. Remove a Gallery View
    5. Share a Gallery View
    6. Lock Gallery View for Edits
    1. Rearrange Fields Within the Gallery
    2. Show or Hide Fields Within the Gallery
    3. Apply Filters to Display Specific Records on the Gallery
    4. Sort Records on the Gallery by One or More Criteria
    5. Perform Quick Searches for Specific Data Within Fields
    6. Export Data to CSV or Excel Format
    7. Change Cover Image
    1. Add a New Record to the Gallery: Currently it is not possible to insert a new record directly on the gallery view. However, you can add a new record to the table, and it will be displayed on the gallery view.
    2. Edit an Existing Record on the Gallery: Click on the card on the gallery view to open the record in the expanded record view. You can edit the record in the form view and save it.
    3. Delete a Single Record from the Gallery: Click on the card on the gallery view to open the record in the expanded record view. You can delete the record in the form view by using the expanded record context menu.
    4. Delete Multiple Records in Bulk from the Gallery: Currently it is not possible to delete multiple records in bulk directly on the gallery view. However, you can delete multiple records in bulk from the grid view & it will be reflected on the gallery view.

    Grid View
    Form View
    Kanban View

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/views/view-types/grid/index.html b/packages/noco-docs/dist/views/view-types/grid/index.html index 7b98c33c94..4d8e3fb18f 100644 --- a/packages/noco-docs/dist/views/view-types/grid/index.html +++ b/packages/noco-docs/dist/views/view-types/grid/index.html @@ -4,15 +4,15 @@ Grid | NocoDB - +
    -
    Version: Latest

    Grid

    Grid View, as a default type of view, allows you to display your data in a spreadsheet-like interface using rows and columns. Rows are as referred to as records and columns as fields in NocoDB.

    1010-2 Grid

    Grid view is the default view type for all tables. This view type is ideal for viewing and editing data in a spreadsheet-like interface. You can also perform various operations on the grid view, such as sorting, filtering, grouping, and searching. You can also export the data in the grid view to CSV or Excel format. This section will cover all the operations that can be performed on the grid view.

    Grid View Actions​

    1. Create a New Grid View
    2. Rename an Existing Grid View
    3. Duplicate a Grid View
    4. Remove a Grid View
    5. Share a Grid View
    6. Lock Grid View for Edits

    Grid View Operations​

    1. Rearrange Fields Within the Grid
    2. Show or Hide Fields Within the Grid
    3. Apply Filters to Display Specific Records on the Grid
    4. Sort Records on the Grid by One or More Criteria
    5. Group Records Horizontally on the Grid
    6. Search for Specific Data Within Fields
    7. Export Data to CSV or Excel Format
    8. Adjust Record Height on the Grid
    9. Customize Field Width
    10. Toggle Field Visibility on the Grid

    Grid View Record Operations​

    1. Add a New Record to the Grid
    2. Edit an Existing Record on the Grid
    3. Delete a Single Record from the Grid
    4. Delete Multiple Records in Bulk from the Grid

    Gallery View
    +

    Version: Latest

    Grid

    Grid View, as a default type of view, allows you to display your data in a spreadsheet-like interface using rows and columns. Rows are as referred to as records and columns as fields in NocoDB.

    1010-2 Grid

    Grid view is the default view type for all tables. This view type is ideal for viewing and editing data in a spreadsheet-like interface. You can also perform various operations on the grid view, such as sorting, filtering, grouping, and searching. You can also export the data in the grid view to CSV or Excel format. This section will cover all the operations that can be performed on the grid view.

    Grid View Actions​

    1. Create a New Grid View
    2. Rename an Existing Grid View
    3. Duplicate a Grid View
    4. Remove a Grid View
    5. Share a Grid View
    6. Lock Grid View for Edits

    Grid View Operations​

    1. Rearrange Fields Within the Grid
    2. Show or Hide Fields Within the Grid
    3. Apply Filters to Display Specific Records on the Grid
    4. Sort Records on the Grid by One or More Criteria
    5. Group Records Horizontally on the Grid
    6. Search for Specific Data Within Fields
    7. Export Data to CSV or Excel Format
    8. Adjust Record Height on the Grid
    9. Customize Field Width
    10. Toggle Field Visibility on the Grid

    Grid View Record Operations​

    1. Add a New Record to the Grid
    2. Edit an Existing Record on the Grid
    3. Delete a Single Record from the Grid
    4. Delete Multiple Records in Bulk from the Grid

    Gallery View
    Form View
    Kanban View

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/views/view-types/kanban/index.html b/packages/noco-docs/dist/views/view-types/kanban/index.html index 7d96f66d9d..be91661597 100644 --- a/packages/noco-docs/dist/views/view-types/kanban/index.html +++ b/packages/noco-docs/dist/views/view-types/kanban/index.html @@ -4,15 +4,15 @@ Kanban | NocoDB - +
    -
    Version: Latest

    Kanban

    Kanban View allows you to visualise your data using cards as part of various stacks on the board. You can easily rearrange the cards by dragging and dropping them to different stacks. This section will cover all the operations that can be performed on the Kanban view.

    1010-2 Kanban

    Kanban View Actions​

    1. Create a New Kanban View
    2. Rename an Existing Kanban View
    3. Duplicate a Kanban View
    4. Remove a Kanban View
    5. Share a Kanban View
    6. Lock Kanban View for Edits

    Kanban View Operations​

    1. Rearrange Fields Within the Kanban
    2. Show or Hide Fields Within the Kanban
    3. Apply Filters to Display Specific Records on the Kanban
    4. Sort Records on the Kanban by One or More Criteria
    5. Perform Quick Searches for Specific Data Within Fields
    6. Export Data to CSV or Excel Format
    7. Change Cover Image

    Kanban View Stacked-by field Operations​

    Change Stacked by Field​

    You can change the field by which the records are stacked on the kanban view by following the steps below:

    1. Click on the Stacked by menu in the toolbar.
    2. Click on field name that is currently selected as the stacked-by field.
    3. From the dropdown, select the new field by which you want to stack the records.

    Change Stacked by Field

    Add/modify Stacked-by Field Options​

    You can add/modify options on the stacked-by single select field by following the steps below:

    1. Click on the Stacked by menu in the toolbar. Dropdown lists all Select Options that are available on this field.
    2. Add/modify as required.
    3. Click on Save to save the changes.

    Add/modify option on the stacked-by single select field

    Collapse Stack​

    To ease the view of the kanban, you can collapse the stack by following the steps below:

    1. Click on the dropdown icon on the stack header.
    2. Select Collapse Stack from the dropdown.
    3. Collapsed Stack will be displayed as vertical bars on the kanban view as displayed below.

    Collapse Stack

    Delete Stack​

    To delete a stack from the kanban view, follow the steps below:

    1. Click on the dropdown icon on the stack header.
    2. Select Delete Stack from the dropdown.
    3. A confirmation dialog will be displayed. Click on Delete to delete the stack.

    Delete Stack

    Delete Stack Confirmation

    Reorder Stacks​

    You can reorder the stacks on the kanban view by dragging and dropping the stack to the desired position.

    Kanban View Record Operations​

    Move Records within Stacks​

    You can move records within a stack by dragging and dropping the card to the desired position within the stack.

    Add a New Record to the Kanban​

    On kanban, you can add a new record directly to a particular stack by using Add Record button on the stack footer. This opens up an expanded record view where you can enter the data for the new record. Once you save the record, it will be displayed on the kanban view. You can also add a new record to the table, and it will be displayed on the kanban view.

    Add Record

    Edit an Existing Record on the Kanban​

    Click on the card on the kanban view to open the record in the expanded record view. You can edit the record in the expanded record view and save it.

    Delete a Single Record from the Kanban​

    Right-click on the card to access the context menu and select the Delete option.

    Grid View
    +

    Version: Latest

    Kanban

    Kanban View allows you to visualise your data using cards as part of various stacks on the board. You can easily rearrange the cards by dragging and dropping them to different stacks. This section will cover all the operations that can be performed on the Kanban view.

    1010-2 Kanban

    Kanban View Actions​

    1. Create a New Kanban View
    2. Rename an Existing Kanban View
    3. Duplicate a Kanban View
    4. Remove a Kanban View
    5. Share a Kanban View
    6. Lock Kanban View for Edits

    Kanban View Operations​

    1. Rearrange Fields Within the Kanban
    2. Show or Hide Fields Within the Kanban
    3. Apply Filters to Display Specific Records on the Kanban
    4. Sort Records on the Kanban by One or More Criteria
    5. Perform Quick Searches for Specific Data Within Fields
    6. Export Data to CSV or Excel Format
    7. Change Cover Image

    Kanban View Stacked-by field Operations​

    Change Stacked by Field​

    You can change the field by which the records are stacked on the kanban view by following the steps below:

    1. Click on the Stacked by menu in the toolbar.
    2. Click on field name that is currently selected as the stacked-by field.
    3. From the dropdown, select the new field by which you want to stack the records.

    Change Stacked by Field

    Add/modify Stacked-by Field Options​

    You can add/modify options on the stacked-by single select field by following the steps below:

    1. Click on the Stacked by menu in the toolbar. Dropdown lists all Select Options that are available on this field.
    2. Add/modify as required.
    3. Click on Save to save the changes.

    Add/modify option on the stacked-by single select field

    Collapse Stack​

    To ease the view of the kanban, you can collapse the stack by following the steps below:

    1. Click on the dropdown icon on the stack header.
    2. Select Collapse Stack from the dropdown.
    3. Collapsed Stack will be displayed as vertical bars on the kanban view as displayed below.

    Collapse Stack

    Delete Stack​

    To delete a stack from the kanban view, follow the steps below:

    1. Click on the dropdown icon on the stack header.
    2. Select Delete Stack from the dropdown.
    3. A confirmation dialog will be displayed. Click on Delete to delete the stack.

    Delete Stack

    Delete Stack Confirmation

    Reorder Stacks​

    You can reorder the stacks on the kanban view by dragging and dropping the stack to the desired position.

    Kanban View Record Operations​

    Move Records within Stacks​

    You can move records within a stack by dragging and dropping the card to the desired position within the stack.

    Add a New Record to the Kanban​

    On kanban, you can add a new record directly to a particular stack by using Add Record button on the stack footer. This opens up an expanded record view where you can enter the data for the new record. Once you save the record, it will be displayed on the kanban view. You can also add a new record to the table, and it will be displayed on the kanban view.

    Add Record

    Edit an Existing Record on the Kanban​

    Click on the card on the kanban view to open the record in the expanded record view. You can edit the record in the expanded record view and save it.

    Delete a Single Record from the Kanban​

    Right-click on the card to access the context menu and select the Delete option.

    Grid View
    Kanban View
    Form View

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/views/views-overview/index.html b/packages/noco-docs/dist/views/views-overview/index.html index 39aa0c79f4..29e4752443 100644 --- a/packages/noco-docs/dist/views/views-overview/index.html +++ b/packages/noco-docs/dist/views/views-overview/index.html @@ -4,17 +4,17 @@ View overview | NocoDB - +
    -
    Version: Latest

    View overview

    Views within NocoDB not only allow you to tailor the visual presentation to your liking but also provide independent +

    Version: Latest

    View overview

    Views within NocoDB not only allow you to tailor the visual presentation to your liking but also provide independent control over sorting and filtering of records within each view. Each view maintains its unique configuration for filters, data display, and enabled fields, ensuring that modifications of these configuration does not impact any other view. This feature empowers users to efficiently personalize their data visualization while maintaining the integrity of other views.

    info

    View represents data from a table. Any updates to records in a view will be reflected in all other views of the same table.

    View Types Supported​

    1. Grid View
    2. Form View
    3. Gallery View
    4. Kanban View

    View Permission Types​

    We can apply permission to each View. By default, views are Collaborative. To see or change the view type, expand view-tool-bar-menu as shown below.

    locked view

    Collaborative Views (default)​

    By default, views are set to "Collaborative," allowing members with edit permissions or higher to modify view configurations. In this mode, all members can read and write data to the view. This is the default mode for all views.

    Locked Views​

    With "Locked Views," no one can edit the view configurations until they are unlocked. In this mode, all members are restricted to reading data from the view and are unable to make any changes to its settings or content. This mode is useful when you want to share a view with others but don't want them to make any changes to it.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/workspaces/actions-on-workspace/index.html b/packages/noco-docs/dist/workspaces/actions-on-workspace/index.html index dc74022866..d16349fef1 100644 --- a/packages/noco-docs/dist/workspaces/actions-on-workspace/index.html +++ b/packages/noco-docs/dist/workspaces/actions-on-workspace/index.html @@ -4,14 +4,14 @@ Actions on workspace | NocoDB - +
    -
    Version: Latest

    Actions on workspace

    Rename workspace​

    To update the workspace name:

    1. Navigate to the Team & Settings option in the left sidebar to access the Workspace configuration page.
    2. Select the Settings tab.
    3. Enter the new desired workspace name in the Workspace Name field.
    4. Confirm the change by clicking on the Rename Workspace button.

    image

    Delete workspace​

    If you determine that a workspace is no longer necessary, you have the option to permanently remove it from your settings. Deleting a workspace will delete all the bases and data associated with it.

    danger

    This action cannot be undone.

    info

    Only workspace owner can delete a workspace.

    To remove a workspace:

    1. Open the Workspace configuration page by selecting Team & Settings from the left sidebar.
    2. Access the Settings tab.
    3. Click on the Delete Workspace button.
    4. Provide the workspace name as confirmation for deletion.
    5. Confirm the action by clicking the Delete Workspace button in the confirmation dialog box.

    image +

    Version: Latest

    Actions on workspace

    Rename workspace​

    To update the workspace name:

    1. Navigate to the Team & Settings option in the left sidebar to access the Workspace configuration page.
    2. Select the Settings tab.
    3. Enter the new desired workspace name in the Workspace Name field.
    4. Confirm the change by clicking on the Rename Workspace button.

    image

    Delete workspace​

    If you determine that a workspace is no longer necessary, you have the option to permanently remove it from your settings. Deleting a workspace will delete all the bases and data associated with it.

    danger

    This action cannot be undone.

    info

    Only workspace owner can delete a workspace.

    To remove a workspace:

    1. Open the Workspace configuration page by selecting Team & Settings from the left sidebar.
    2. Access the Settings tab.
    3. Click on the Delete Workspace button.
    4. Provide the workspace name as confirmation for deletion.
    5. Confirm the action by clicking the Delete Workspace button in the confirmation dialog box.

    image image

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/workspaces/create-workspace/index.html b/packages/noco-docs/dist/workspaces/create-workspace/index.html index ac26944223..4af4dfd344 100644 --- a/packages/noco-docs/dist/workspaces/create-workspace/index.html +++ b/packages/noco-docs/dist/workspaces/create-workspace/index.html @@ -4,17 +4,17 @@ Create workspace | NocoDB - +
    -
    Version: Latest

    Create workspace

    Upon signing up to NocoDB, an initial workspace is automatically generated on your behalf. +

    Version: Latest

    Create workspace

    Upon signing up to NocoDB, an initial workspace is automatically generated on your behalf. Then you have the ability to either modify its name or creating an entirely new workspace.

    In the following section, lets look at the process of creating your NocoDB workspaces.

    Create a workspace​

    1. Navigate to the top-left corner of the sidebar and select the Workspace name to access the Workspace context menu.
    2. From the Workspace context menu, opt for the Create workspace button.
    3. Provide a name for the workspace
    4. Proceed by clicking the Create Workspace button.

    image

    image

    When you start a new workspace, you automatically become the owner. Once your workspace is set up, you can create tables and invite others to join and work together. You can invite as many people as you want, and you can create as many tables as you need in your workspace. But remember, there can only be one owner, and only the owner can delete the workspace.

    info

    The Open Source NocoDB includes a default workspace, and it does not allow the creation of additional workspaces.

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/workspaces/workspace-collaboration/index.html b/packages/noco-docs/dist/workspaces/workspace-collaboration/index.html index cb69510333..e16f8c718b 100644 --- a/packages/noco-docs/dist/workspaces/workspace-collaboration/index.html +++ b/packages/noco-docs/dist/workspaces/workspace-collaboration/index.html @@ -4,14 +4,14 @@ Workspace collaboration | NocoDB - +
    -
    Version: Latest

    Workspace collaboration

    Next logical step after creating a workspace is to invite members to it. In this section, we will guide you through the process of inviting members to your workspace. +

    Version: Latest

    Workspace collaboration

    Next logical step after creating a workspace is to invite members to it. In this section, we will guide you through the process of inviting members to your workspace. A comprehensive guide regarding roles and permissions can be accessed here.

    Invite members to Workspace​

    1. Navigate to the Workspace configuration page by selecting Team & Settings in the left sidebar.
    2. Access the Members tab.
    3. Input the email address of the intended member for the invitation.
    4. Click on Role dropdown menu
    5. Choose the appropriate access permission for the member from the dropdown menu.
    6. Conclude the process by selecting the Add Member(s) button.

    image

    tip

    You can invite multiple members simultaneously by entering their email addresses, separated by commas.

    List Workspace members​

    The Members tab in Team & Settings displays a list of users who have been granted access to the workspace.

    1. Navigate to the Workspace configuration page by selecting Team & Settings in the left sidebar.
    2. Access the Members tab.

    image

    Modify Workspace Member Roles​

    You can modify the access permissions of members by following these steps:

    1. Navigate to the Workspace configuration page by selecting Team & Settings in the left sidebar.
    2. Access the Members tab.
    3. Access the dropdown menu.
    4. Select the desired new role option.

    image

    Remove Workspace Members​

    To remove a member from the workspace, take the following steps:

    1. Navigate to the Workspace configuration page by selecting Team & Settings in the left sidebar.
    2. Access the Members tab.
    3. Click on the vertical ellipses ⋮ to open the context menu.
    4. Select the Remove User option.

    image

    - + \ No newline at end of file diff --git a/packages/noco-docs/dist/workspaces/workspace-overview/index.html b/packages/noco-docs/dist/workspaces/workspace-overview/index.html index c9ea29969b..7826d07533 100644 --- a/packages/noco-docs/dist/workspaces/workspace-overview/index.html +++ b/packages/noco-docs/dist/workspaces/workspace-overview/index.html @@ -4,14 +4,14 @@ Workspace overview | NocoDB - +
    -
    Version: Latest

    Workspace overview

    In NocoDB, workspaces play a pivotal role in facilitating collaborative and organized data management. A workspace serves as a container for one or more bases, allowing users to bring together interconnected tables, views, and various elements into a unified and coherent entity. Each workspace can house multiple bases, enabling users to categorize and structure their data in a way that suits their specific needs. Whether you're tracking projects, managing databases, or organizing information, NocoDB's workspaces provide the flexibility and organization required to make data-driven decisions and foster collaboration within your team. Additionally, workspaces allow for the assignment of specific access permissions to workspace members, ensuring that data security and privacy are maintained while enabling effective teamwork.

    Some key points to note about workspaces are:

    1. Each workspace contains its own set of bases, keeping your data separate and well-organized.
    2. Workspaces have their own set of members and permissions, allowing you to control who can access and modify data within each workspace.
    3. Workspaces offer unique settings and billing options, letting you customize configurations to suit specific needs.
    4. Bases are tied exclusively to one workspace and can't be moved between workspaces, ensuring data integrity.
    5. Members can be part of multiple workspaces. You can also fine-tune their roles within each workspace.

    In summary, NocoDB workspaces streamline data management and member control, providing the flexibility and oversight necessary for various projects and teams.

    To begin, you can create a workspace tailored to your project. Collaborate seamlessly by inviting team members to the workspace. If roles need adjustment, simply modify a team member's role. When necessary, you can also remove team members from the workspace. For organizational purposes, renaming the workspace is straightforward with the rename workspace feature. Finally, if a workspace is no longer needed, you can easily delete it.

    info

    The Open Source NocoDB includes a default workspace, and it does not allow the creation of additional workspaces.

    Workspace context menu​

    The workspace context menu, conveniently located in the left top of sidebar, provides a list of all the workspaces accessible to you. +

    Version: Latest

    Workspace overview

    In NocoDB, workspaces play a pivotal role in facilitating collaborative and organized data management. A workspace serves as a container for one or more bases, allowing users to bring together interconnected tables, views, and various elements into a unified and coherent entity. Each workspace can house multiple bases, enabling users to categorize and structure their data in a way that suits their specific needs. Whether you're tracking projects, managing databases, or organizing information, NocoDB's workspaces provide the flexibility and organization required to make data-driven decisions and foster collaboration within your team. Additionally, workspaces allow for the assignment of specific access permissions to workspace members, ensuring that data security and privacy are maintained while enabling effective teamwork.

    Some key points to note about workspaces are:

    1. Each workspace contains its own set of bases, keeping your data separate and well-organized.
    2. Workspaces have their own set of members and permissions, allowing you to control who can access and modify data within each workspace.
    3. Workspaces offer unique settings and billing options, letting you customize configurations to suit specific needs.
    4. Bases are tied exclusively to one workspace and can't be moved between workspaces, ensuring data integrity.
    5. Members can be part of multiple workspaces. You can also fine-tune their roles within each workspace.

    In summary, NocoDB workspaces streamline data management and member control, providing the flexibility and oversight necessary for various projects and teams.

    To begin, you can create a workspace tailored to your project. Collaborate seamlessly by inviting team members to the workspace. If roles need adjustment, simply modify a team member's role. When necessary, you can also remove team members from the workspace. For organizational purposes, renaming the workspace is straightforward with the rename workspace feature. Finally, if a workspace is no longer needed, you can easily delete it.

    info

    The Open Source NocoDB includes a default workspace, and it does not allow the creation of additional workspaces.

    Workspace context menu​

    The workspace context menu, conveniently located in the left top of sidebar, provides a list of all the workspaces accessible to you. You can easily switch between different workspaces by simply clicking on the respective workspace name within this menu.

    image

    - + \ No newline at end of file