Browse Source

docs: base operations

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
pull/6467/head
Raju Udava 1 year ago
parent
commit
4342932e58
  1. 1
      packages/noco-docs/docs/030.workspaces/020.create-workspace.md
  2. 4
      packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md
  3. 13
      packages/noco-docs/docs/040.bases/020.create-base.md
  4. 64
      packages/noco-docs/docs/040.bases/070.import-base-from-airtable.md
  5. 18
      packages/noco-docs/docs/040.bases/075.base-collaboration.md
  6. 20
      packages/noco-docs/docs/040.bases/080.delete-base.md
  7. 56
      packages/noco-docs/docs/040.bases/090.actions-on-base.md
  8. BIN
      packages/noco-docs/static/img/v2/base-context-menu.png
  9. BIN
      packages/noco-docs/static/img/v2/base-delete-confirmation.png
  10. BIN
      packages/noco-docs/static/img/v2/base-delete.png
  11. BIN
      packages/noco-docs/static/img/v2/create-base-2.png
  12. BIN
      packages/noco-docs/static/img/v2/create-base.png
  13. BIN
      packages/noco-docs/static/img/v2/duplicate-base-1.png
  14. BIN
      packages/noco-docs/static/img/v2/duplicate-base-2.png
  15. BIN
      packages/noco-docs/static/img/v2/duplicate-base-3.png
  16. BIN
      packages/noco-docs/static/img/v2/invite-collaborators.png
  17. BIN
      packages/noco-docs/static/img/v2/rename-base-1.png
  18. BIN
      packages/noco-docs/static/img/v2/rename-base-2.png
  19. BIN
      packages/noco-docs/static/img/v2/starred-base-1.png
  20. BIN
      packages/noco-docs/static/img/v2/starred-base-2.png
  21. BIN
      packages/noco-docs/static/img/v2/starred-base-remove.png

1
packages/noco-docs/docs/030.workspaces/020.create-workspace.md

@ -17,7 +17,6 @@ In the following section, we will guide you through the process of creating your
![image](/img/v2/create-workspace-1.png) ![image](/img/v2/create-workspace-1.png)
![image](/img/v2/create-workspace-2.png) ![image](/img/v2/create-workspace-2.png)

4
packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md

@ -15,6 +15,10 @@ Next logical step after creating a workspace is to invite collaborators to it. I
![image](/img/v2/workspace-collaboration.png) ![image](/img/v2/workspace-collaboration.png)
:::info
You can invite multiple collaborators at once by entering multiple email addresses separated by comma.
:::
### List of collaborators ### List of collaborators
List of the users who have access to the workspace is displayed on the same page. Refer **<1>** below. List of the users who have access to the workspace is displayed on the same page. Refer **<1>** below.

13
packages/noco-docs/docs/040.bases/020.create-base.md

@ -5,3 +5,16 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
## Create base from scratch ## Create base from scratch
1. Click on `+` on the left sidebar next to `projects` OR click on `+ New Project` button on the left sidebar.
2. Fill in the name of the base in the pop-up modal.
3. Click on `Create Database` button.
![image](/img/v2/create-base.png)
![image](/img/v2/create-base-2.png)
:::info
- You will be marked as `base owner` on creation of the base.
- Only `base owner` has the authority to delete a base.
- You can create multiple bases within a workspace.
:::

64
packages/noco-docs/docs/040.bases/070.import-base-from-airtable.md

@ -1,5 +1,67 @@
--- ---
title: 'Import base from Airtable' title: 'Import Airtable to NocoDB'
description: 'A complete import of your Airtable to any MySQL, Postgres, SQLite and SQL server databases within minutes'
--- ---
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
NocoDB allows a complete import of your Airtable base to any MySQL, Postgres, SQLite and SQL server databases within minutes.
:::info
Import from Airtable is in beta version. See [Importing Airtable To NocoDB](https://github.com/nocodb/nocodb/discussions/2122) for the migration notes.
:::
## Import Airtable to NocoDB
:::info
Prerequisites: <br/> - A NocoDB Base <br/> - Airtable Credentials
:::
Below are 3 simple steps
1. Go to your Base dashboard, click on `Import Data`
![import data](https://github.com/nocodb/nocodb/assets/86527202/e5ca7748-5918-4fec-a2f5-6ffa7ab753f8)
2. Select `Airtable`
![import data airtable](https://github.com/nocodb/nocodb/assets/86527202/c9f4aab6-4de3-4e24-808a-27d4f10104ce)
3. Input API key & Shared Base ID / URL (retrieved from `Get Airtable Credentials` above).
a. API Key
b. Share Base ID
c. 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
`Import Formula Columns`: disable this option to skip Formula column import (Not available yet)
![Screenshot 2022-09-14 at 9 30 14 AM](https://user-images.githubusercontent.com/86527202/190057133-92807b16-4f2b-4c58-8bae-a2cfe677ee62.png)
4. Click `Import` and you will see the status
5. 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](https://user-images.githubusercontent.com/86527202/190057152-be9ec6cb-e414-465c-8967-d1ad40478ce1.png)
## Get Airtable Credentials
:::info
You need to retrieve API key and Shared Base ID / URL from Airtable.
:::
### Retrieve API Key
- Copy your Airtable API Key from [Airtable Accounts](https://airtable.com/account) page
![Screenshot 2022-05-16 at 1 50 07 PM](https://user-images.githubusercontent.com/86527202/168569905-48c16d6d-c44a-4337-be49-0ac3dc1f7b75.png)
### Retrieve Share Base ID / URL
See [here](https://support.airtable.com/hc/en-us/articles/205752117-Creating-a-base-share-link-or-a-view-share-link#basesharelink) for detailed procedures.
1. Open `Share` menu in your Project / Base
![Screenshot 2022-05-16 at 3 47 27 PM](https://user-images.githubusercontent.com/86527202/168572054-533b8c19-d76e-4add-b876-f1e0570ac33c.png)
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](https://user-images.githubusercontent.com/86527202/168572062-5dee065d-2394-426d-8f43-77ecc0c9b73f.png)

18
packages/noco-docs/docs/040.bases/075.base-collaboration.md

@ -0,0 +1,18 @@
---
title: 'Base Collaboration'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Invite collaborators to your base by following simple steps below:
1. Click on `Base name` on the left sidebar to open `Base Dashboard`.
2. Select `Collaborators` tab.
3. Fill in the email address of the collaborator you want to invite.
4. Select the access permission for the collaborator from the dropdown menu.
5. Click on `Add User(s)` button.
![image](/img/v2/invite-collaborators.png)
:::info
You can invite multiple collaborators at once by entering multiple email addresses separated by comma.
:::

20
packages/noco-docs/docs/040.bases/080.delete-base.md

@ -3,3 +3,23 @@ title: 'Delete base'
--- ---
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
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. Open `base context menu` by clicking on the ellipses `...` next to base name` on the left sidebar.
2. From the dropdown, select `Delete` option.
3. Click on `Delete base` button on the confirmation dialog box.
![image](/img/v2/base-delete.png)
![image](/img/v2/base-delete-confirmation.png)

56
packages/noco-docs/docs/040.bases/090.actions-on-base.md

@ -3,3 +3,59 @@ title: 'Actions on base'
--- ---
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
## Base context menu
Base context menu provides access to some of quick actions you can perform on a base. You can access base context menu by clicking on the ellipses `...` next to base name on the left sidebar.
![image](/img/v2/base-context-menu.png)
## Rename base
You can rename a base by following simple steps below:
1. Open `base context menu` by clicking on the ellipses `...` next to base name` on the left sidebar.
2. From the dropdown, select `Rename` option.
3. Fill in the new name of the base inline, press `Enter` to save the new name.
![image](/img/v2/rename-base-1.png)
![image](/img/v2/rename-base-2.png)
## Star (bookmark) a base
You can star a base by following simple steps below:
1. Open `base context menu` by clicking on the ellipses `...` next to base name` on the left sidebar.
2. From the dropdown, select `Add to Starred` option.
3. Base will be added to `Starred` section on the left sidebar.
![image](/img/v2/starred-base-1.png)
![image](/img/v2/starred-base-2.png)
:::info
Starred base will appear in both `Starred` section and `All Bases` section on the left sidebar.
:::
### Remove a base from starred list
1. Open `base context menu` by clicking on the ellipses `...` next to base name` on the left sidebar.
2. From the dropdown, select `Remove from Starred` option.
3. Base will be removed from `Starred` section on the left sidebar.
![image](/img/v2/starred-base-remove.png)
## Duplicate base
You can duplicate a base by following simple steps below:
1. Open `base context menu` by clicking on the ellipses `...` next to base name` on the left sidebar.
2. From the dropdown, select `Duplicate` option.
3. Optional configurations
a) You can choose to duplicate the base with or without data.
b) You can choose to duplicate the base with or without views.
4. Click on `Confirm` button on the confirmation modal.
5. New base will be created with the same schema and data/view as in the original base, based on configurations as specified in step (3).
![image](/img/v2/duplicate-base-1.png)
![image](/img/v2/duplicate-base-2.png)
![image](/img/v2/duplicate-base-3.png)
:::info
- Duplicate base will be created in the same workspace as the original base
- Duplicate base will carry suffix ` Copy` in its name.
- You will be marked as `base owner` on duplication of the base.
- Existing base collaborators are not migrated to the duplicated base.
:::

BIN
packages/noco-docs/static/img/v2/base-context-menu.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 408 KiB

BIN
packages/noco-docs/static/img/v2/base-delete-confirmation.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 285 KiB

BIN
packages/noco-docs/static/img/v2/base-delete.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 275 KiB

BIN
packages/noco-docs/static/img/v2/create-base-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 305 KiB

BIN
packages/noco-docs/static/img/v2/create-base.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 228 KiB

BIN
packages/noco-docs/static/img/v2/duplicate-base-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 287 KiB

BIN
packages/noco-docs/static/img/v2/duplicate-base-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 432 KiB

BIN
packages/noco-docs/static/img/v2/duplicate-base-3.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 259 KiB

BIN
packages/noco-docs/static/img/v2/invite-collaborators.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 290 KiB

BIN
packages/noco-docs/static/img/v2/rename-base-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 254 KiB

BIN
packages/noco-docs/static/img/v2/rename-base-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

BIN
packages/noco-docs/static/img/v2/starred-base-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 256 KiB

BIN
packages/noco-docs/static/img/v2/starred-base-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 234 KiB

BIN
packages/noco-docs/static/img/v2/starred-base-remove.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 258 KiB

Loading…
Cancel
Save