Browse Source

Nc docs/update for release (#8842)

* docs: update RO data-source

* docs: summary footer

* docs: summary footer

* docs: code rabbit fix
pull/8850/head
Raju Udava 5 months ago committed by GitHub
parent
commit
3b9671445c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 78
      packages/noco-docs/docs/070.fields/055.field-summary-footer.md
  2. 37
      packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md
  3. BIN
      packages/noco-docs/static/img/v2/data-source/data-source-permissions.png
  4. BIN
      packages/noco-docs/static/img/v2/fields/field-summary-footer/field-summary-footer-1.png

78
packages/noco-docs/docs/070.fields/055.field-summary-footer.md

@ -0,0 +1,78 @@
---
title: "Field summary"
description: "Understanding the field summary bar in NocoDB!"
tags: ['Fields', 'Field Summary', 'Productivity hacks']
keywords : ['NocoDB field summary', 'field summary bar', 'field summary in nocoDB']
---
The "Field Summary" provides quick calculations for chosen fields displayed in the footer of a table's grid view. These calculations offer quick insights into your data, such as total sums, averages, minimum, and maximum values.
This section explains how to use & configure field summary to accurately compute these values.
## Overview
Field Summary is aggregated value computed by considering all the rows present in a grid view. The resulting values are displayed in the summary cells at the bottom of the field for easy reference. Filters configured on the grid, if any will affect the rows displayed & hence the summary as well.
Please note that it is not possible to reference these aggregated values directly in other parts of the table.
When a grid view is **shared publicly**, the summary is also visible to the viewers. Viewers of shared view can also modify the field summary configuration to suit their needs, but the changes are not saved (revert upon page refresh).
Summary configurations are grid **view specific**. Multiple grid views can be created for a table, and each grid view can have its own summary configuration.
## Configuring Field Summary
By default, the summary is disabled for all fields. To enable the summary for a field, follow these steps:
Navigate to the grid view of the table you wish to configure the field summary for.
1. Click on the cell of the field you wish to configure the summary for.
2. Select the desired summary type from the dropdown list.
![Access](/img/v2/fields/field-summary-/field-summary--1.png)
Changes to the grid view immediately update the values displayed in the footer cells. To disable the summary for a field, click on the summary cell and select "None" from the dropdown list.
## Summary Types
Summary function types available for configuration depend on the field type. General functions listed below are available for most of the field types:
### General
- **Empty**: Count of empty cells in the field.
- **Filled**: Count of non-empty cells in the field.
- **Unique**: Count of unique values in the field.
- **Percent Empty**: Percentage of empty cells in the field.
- **Percent Filled**: Percentage of non-empty cells in the field.
- **Percent Unique**: Percentage of unique values in the field.
Apart from these general functions, specific functions are available for different field types:
### Numeric
- **Sum**: Sum of all numeric values in the field.
- **Minimum**: Minimum value in the field.
- **Maximum**: Maximum value in the field.
- **Average**: Average of all numeric values in the field.
- **Median**: Median of all numeric values in the field.
- **Standard Deviation**: Standard deviation of all numeric values in the field.
- **Range**: Range of all numeric values in the field.
### Date
- **Earliest Date**: Earliest date in the field.
- **Latest Date**: Latest date in the field.
- **Date Range**: Range of dates in the field.
- **Month Range**: Range of months in the field.
### Checkbox
- **Checked**: Count of checked checkboxes in the field.
- **Unchecked**: Count of unchecked checkboxes in the field.
- **Percent Checked**: Percentage of checked checkboxes in the field.
- **Percent Unchecked**: Percentage of unchecked checkboxes in the field.
### Attachment
- **Attachment Size**: Total size of attachments in the field.
:::note
Summary configuration is not available for `DB specific field` types.
:::

37
packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md

@ -51,34 +51,39 @@ To connect to an external data source, follow the steps below:
## Configuring Permissions
When connecting NocoDB to external data sources such as PostgreSQL, it is crucial to configure the appropriate permissions to ensure data integrity and security. This section explains the options available for schema and data editing, allowing you to tailor the access levels according to your requirements.
This section covers the settings available when configuring data source permissions. These settings determine the level of access and modifications allowed on the connected database.
![data source-1](/img/v2/data-source/data-source-permissions.png)
NocoDB provides the following options for schema and data permissions:
### Schema Permissions
This option enables users to modify the structure of the database schema. When enabled, users can create, modify, and delete tables, fields and relationships (links) within the connected datasource from NocoDB UI. This provides flexibility to adjust the database design as needed from UI but should be used with caution.
### Allow Data Edit
This option when enabled, users can insert, update, and delete records from the tables. This provides the flexibility to manage the data directly from the NocoDB UI but should be used with caution to avoid unintentional changes to the records in the external data source. This level of access is ideal for administrative users who need to modify data directly.
Toggle `Allow Schema Edit` to enable or disable schema editing for the connected datasource. By default, schema editing is disabled.
By default, data editing is enabled
Even when schema editing is disabled, users can still
When data editing is disabled, users can still view the data and perform read-only operations such as filtering, sorting, and grouping. This ensures that users can access the data for analysis and reporting purposes without the risk of modifying the records.
- add (augment) virtual columns such as Lookup, Rollup and Formula. These virtual columns do not alter the underlying schema of the connected data source.
- create views to customize the data presentation without modifying the original tables.
- create webhooks to trigger external actions based on specific events within the connected datasource.
- collaborate with other users by explicitly inviting them to the base or by sharing views.
:::note
Data editing can only be disabled when schema editing is also disabled
:::
### Data Permissions
This option enables users to modify the data (records) within the connected datasource. When enabled, users can insert, update, and delete records from the tables. This provides the flexibility to manage the data directly from the NocoDB UI but should be used with caution to avoid unintentional changes to the records in the external data source.
### Allow Schema Edit
This option enables users to modify the structure of the database schema. When enabled, users can create, modify, and delete tables, fields and relationships (links) within the connected datasource from NocoDB UI. This provides flexibility to adjust the database schema design as needed from UI.
Toggle `Allow Data Edit` to enable or disable data editing for the connected datasource. By default, data editing is enabled.
:::warning
NocoDB strongly advises against enabling the schema editing option unless absolutely necessary. Use with extreme caution, as improper changes can severely impact the data integrity and functionality of the connected data source.
:::
When data editing is disabled, users can still view the data and perform read-only operations such as filtering, sorting, and grouping. This ensures that users can access the data for analysis and reporting purposes without the risk of modifying the records.
By default, schema editing is disabled.
Even when schema editing is disabled, users can still
- add (augment) virtual columns such as Lookup, Rollup and Formula. These virtual columns do not alter the underlying schema of the connected data source.
- create views to customize the data presentation without modifying the original tables.
- create webhooks to trigger external actions based on specific events within the connected datasource.
- collaborate with other users by explicitly inviting them to the base or by sharing views.
:::note
Data editing can only be disabled when schema editing is also disabled
:::

BIN
packages/noco-docs/static/img/v2/data-source/data-source-permissions.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 157 KiB

After

Width:  |  Height:  |  Size: 292 KiB

BIN
packages/noco-docs/static/img/v2/fields/field-summary-footer/field-summary-footer-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 384 KiB

Loading…
Cancel
Save