Browse Source

docs: draft updates

pull/9914/head
Raju Udava 3 days ago
parent
commit
d65d08feea
  1. 23
      packages/noco-docs/docs/135.extensions/010.overview.md
  2. 27
      packages/noco-docs/docs/135.extensions/020.data-exporter.md
  3. 36
      packages/noco-docs/docs/135.extensions/030.import-csv.md
  4. 8
      packages/noco-docs/docs/135.extensions/_category_.json
  5. 2
      packages/noco-docs/docs/160.developer-resources/030.extensions/010.developing-extensions.md

23
packages/noco-docs/docs/135.extensions/010.overview.md

@ -0,0 +1,23 @@
---
title: 'Overview'
description: 'Overview of the extensions available in NocoDB'
tags: ['Extensions', 'Overview']
keywords: ['Extensions overview', 'Add Extensions', 'Extension framework', 'Extension settings']
---
**Extensions** are modular components that allow you to extend the way you interact with NocoDB. In a way, they are like plugins that add new features or functionalities to the platform. Not all features are built into the core of NocoDB, and that's where Extensions come in. Users can now go beyond the default features of NocoDB, tailoring the platform to better fit their specific needs and workflows.
In this section, we will guide you through understanding extensions framework, how to install and manage them, and how they can be used to enhance your base.
- [Extension Marketplace](overview#extension-marketplace)
- [Add Extensions](overview#adding-extensions)
- [Manage Extensions](overview#managing-extensions)
Extensions can be developed using JavaScript & Vue.js, providing a flexible way to add new features to your NocoDB instance. Read more about developing extensions [here](/developer-resources/extensions/developing-extensions).
## Extension Marketplace
## Adding Extensions
## Managing Extensions

27
packages/noco-docs/docs/135.extensions/020.data-exporter.md

@ -0,0 +1,27 @@
---
title: 'Data Exporter'
description: 'Export data from NocoDB in various formats'
tags: ['Extensions', 'Data Exporter', 'Export', 'Data', 'JSON', 'CSV', 'Excel']
keywords: ['Data Exporter', 'Export data', 'Export JSON', 'Export CSV', 'Export Excel']
---
## Overview
Data Exporter extension is designed to simplify the process of exporting data from your NocoDB tables. With just a few clicks, you can effortlessly download CSV files for any specific table and view within your base. The download process is handled asynchronously in the background, ensuring that your application usage remains uninterrupted. Once your file is ready, you’ll receive a notification, allowing you to download the CSV at your convenience.
## Exporting Data
To export data from your NocoDB tables, follow the steps outlined below:
1. Select the table & associated view you wish to export.
2. Click on the **Export** button.
3. Once the export is complete, the file will be listed in the **Recent Exports** section.
4. Click on the **Download** button to save the CSV file to your local system.
## Managing Exports
The files exported have a limited lifespan and are automatically removed after 6 hours. The files listed under the **Recent Exports** section are only visible to you and are not shared with other users. You can manage your exports by downloading or removing them as needed.
### Downloading Exports
- In the **Recent Exports** section, locate the file you wish to download.
- Click the **Download** icon next to the export to save it to your device.
### Removing Exports
- If you no longer need a particular export, click the `X` icon next to it to remove it from the list.

36
packages/noco-docs/docs/135.extensions/030.import-csv.md

@ -0,0 +1,36 @@
---
title: 'Import CSV'
description: 'Import data from CSV files into NocoDB'
tags: ['Extensions', 'Import', 'CSV', 'Data Import', 'Data']
keywords: ['Import CSV', 'Import data', 'CSV import', 'Data import', 'CSV files']
---
## Overview
The Import CSV Extension in NocoDB allows users to import data from CSV files directly into existing tables. This tool helps in adding new records, updating existing ones, and efficiently mapping CSV columns to NocoDB fields.
## Importing Data
### Mode
The Import CSV Extension supports two modes of data import:
- **Add Records**: This option adds all records from the CSV file as new entries in the table.
- **Merge Records**: This option updates existing records based on a specified field in the CSV file.
- Create New Records Only: Only adds new records from the CSV. Existing records are not updated.
- Update Existing Records Only: Only updates records that already exist in the table based on the merge field. New records are not added.
- Create and Update Records: Adds new records and updates existing ones as needed.
**Merge Field** is field that will be used to match records from the CSV file with existing records in NocoDB for the purpose of updating.
Field Mapping: You can select the fields from the CSV file to import and map them to the corresponding fields in the NocoDB table.
### Steps
To import data from a CSV file into NocoDB, follow these steps:
1. Select the table you wish to import data into.
2. Click on the **Import CSV** button.
3. Choose the CSV file you want to import.
4. Select the mode of import: **Add Records** or **Merge Records**.
5. If you choose **Merge Records**, select the **Merge Field**.
6. Map the CSV columns to the NocoDB fields.
7. Click on the **Import** button to start the import process.
Once you've configured the import settings and mapped your fields, NocoDB will process the CSV file and update the table according to your specified settings. A summary of new, updated, and unchanged records will be displayed at the bottom of the interface.

8
packages/noco-docs/docs/135.extensions/_category_.json

@ -0,0 +1,8 @@
{
"label": "Extensions",
"collapsible": true,
"collapsed": true,
"link": {
"type": "generated-index"
}
}

2
packages/noco-docs/docs/160.developer-resources/030.extensions/010.developing-extensions.md

@ -55,7 +55,7 @@ In your new folder, create a `manifest.json` file that describes the extension a
Inside your extension folder, create an `index.vue` file. This file contains the Vue component that defines the UI and functionality of your extension.
The `index.vue` file should include the standard sections for a Vue component: <template>, <script>, and <style>. Here’s a basic example to get you started:
The `index.vue` file should include the standard sections for a Vue component: <template></template>, <script></script>, and <style></style>. Here’s a basic example to get you started:
```vue
<script setup lang="ts">

Loading…
Cancel
Save