# Notion Database {% hint style="info" %} This widget supports multiple actions. For a more comprehensive understanding of its functionality, we recommend reviewing the following documentation carefully. You need to pass both the `action` and other input parameters of the chosen action to your `module_config` {% endhint %} ## Try it in the Widget Center Click this [url](https://app.myshell.ai/robot-workshop/widget/1782389035948912640) to try this widget and copy the Pro Config template. ## Usage ### Query the Whole Database `action` `query_all` **Input Parameters**

Name	Type	Description	Default	Required
url	`string`	URL of the public database	default_url	true
action	`string`	The action you want to perform	query_all	true

**Output Parameters** | Name | Type | Description | File Type | | ---- | ------- | ----------------------------- | --------- | | data | `array` | The returned database in list | | **Output Example** {% tabs %} {% tab title="success" %} {% code fullWidth="false" %} ```json { "data": [ { "Age": "15", "Name": "Jack", "Password": "password1", "Phone Number": "13033331111" }, { "Age": "34", "Name": "Taylor", "Password": "password2", "Phone Number": "13100001111" }, { "Age": "17", "Name": "Harry", "Password": "password3", "Phone Number": "13888883333" }, { "Age": "43", "Name": "Sherlock", "Password": "password4", "Phone Number": "15909098787" } ] } ``` {% endcode %} {% endtab %} {% endtabs %} ### Obtain the Column Names `action` `query_schema` **Input Parameters**

Name	Type	Description	Default	Required
url	`string`	URL of the public database	default_url	true
action	`string`	The action you want to perform	query_schema	true

**Output Parameters** | Name | Type | Description | File Type | | ---- | ------- | -------------------------------- | --------- | | data | `array` | The column names of the database | | **Output Example** {% tabs %} {% tab title="success" %} {% code fullWidth="false" %} ```json { "data": [ "Phone Number", "Age", "Password", "Name" ] } ``` {% endcode %} {% endtab %} {% endtabs %} ### Query All Values of a Specific Column `action` `query_column` **Input Parameters**

Name	Type	Description	Default	Required
url	`string`	URL of the public database	default_url	true
action	`string`	The action you want to perform	query_column	true
column_name	`string`	Colume name to query		true

**Output Parameters** | Name | Type | Description | File Type | | ---- | ------- | ---------------------------------- | --------- | | data | `array` | The values under a specific column | | **Output Example** {% tabs %} {% tab title="success" %} {% code fullWidth="false" %} ```json { "data": [ "Jack", "Taylor", "Harry", "Sherlock" ] } ``` {% endcode %} {% endtab %} {% endtabs %} ### Query The Database with SQL `action` `query_sql` This action provides an advanced query with SQL. The table name is defined as `DATA` **Input Parameters**

Name	Type	Description	Default	Required
url	`string`	URL of the public database	default_url	true
action	`string`	The action you want to perform	query_sql	true
sql_str	`string`	SQL string to query, please use it like 'SELECT * FROM database'	SELECT * FROM DATA WHERE Age < 18	true

**Output Parameters** | Name | Type | Description | File Type | | ---- | ------- | ----------------------------------------------- | --------- | | data | `array` | The query results of the public Notion database | | **Output Example** {% tabs %} {% tab title="success" %} {% code fullWidth="false" %} ```json { "data": [ { "Age": "15", "Name": "Jack", "Password": "password1", "Phone Number": "13033331111" }, { "Age": "17", "Name": "Harry", "Password": "password3", "Phone Number": "13888883333" } ] } ``` {% endcode %} {% endtab %} {% endtabs %} ### Add Rows `action` `add_rows` This action provides a interface to add rows to a public notion database **Input Parameters**

Name	Type	Description	Default	Required
url	`string`	URL of the public database	default_url	true
action	`string`	The action you want to perform	add_rows	true
rows_info	`string`	Rows information to add	[{}]	true

**Output Parameters** | Name | Type | Description | File Type | | ---- | ------- | ----------------------------------------------- | --------- | | data | `array` | The query results of the public Notion database | | **Output Example** {% tabs %} {% tab title="success" %} {% code fullWidth="false" %} ```json { "data": [ { "result": "success" } ] } ``` {% endcode %} {% endtab %} {% endtabs %} ## Detailed Guidelines In notion, we can type `/database` to create a database. Then click the `open as full page` as below:

click the share button and copy the url to feed into your Notion Database widget:

If you want to add information to the notion, you can use the`add_rows`action. The json format should follow the format like ``` [{"Name": "Jack", "Phone Number": "13033331111", "Password": "password1"}] ``` However, f you want to use it in pro config use values of variables, please note that the`"`symbols should be escaped like ```json [{\"Name\": \"{{name}}\", \"Phone Number\": \"{{phone_number}}\", \"Password\": \"{{password}}\"}] ``` The sturcture of proconfig may looks like ```json { "id": "notion_add_rows_template", "initial": "home_state", "states": { "home_state": { "inputs": { "url": { "type": "text", "description":"URL of the public database", "user_input": true }, "name": { "type": "text", "user_input": true }, "phone_number": { "type": "text", "user_input": true }, "password": { "type": "text", "user_input": true } }, "tasks": [ { "name": "any_module_example_task", "module_type": "AnyWidgetModule", "module_config": { "widget_id": "1782389035948912640", "url":"{{url}}", // this field will received value from user input "action":"add_rows", // The action you want to perform "rows_info":"[{\"Name\": \"{{name}}\", \"Phone Number\": \"{{phone_number}}\", \"Password\": \"{{password}}\"}]", // Rows information to add "output_name": "result" } } ], "render": { "text": "{{JSON.stringify(result)}}", // this widget will output a map, you can first run it and know what its type is. "buttons": [ { "content":"Try Again", "description":"", "on_click":"try_again" } ] }, "transitions": { "try_again": "home_state" } } } } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://myshell-wiki.gitbook.io/proconfig-tutorial/api-reference/widgets/23-notion-database.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.