noco-db-python-sdk 0.0.2
Client for NocoDB v2
License: MIT
Requires Python: <4.0,>=3.8

<div align="center">

[![Visit Nocodb](./header.png)](https://nocodb.com)

# Nocodb<a id="nocodb"></a>

NocoDB API Documentation


</div>

## Table of Contents<a id="table-of-contents"></a>

<!-- toc -->

- [Requirements](#requirements)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Async](#async)
- [Raw HTTP Response](#raw-http-response)
- [Reference](#reference)
  * [`nocodb.api_token.create_in_base`](#nocodbapi_tokencreate_in_base)
  * [`nocodb.api_token.delete_in_base`](#nocodbapi_tokendelete_in_base)
  * [`nocodb.api_token.list_in_base`](#nocodbapi_tokenlist_in_base)
  * [`nocodb.auth.add_base_user`](#nocodbauthadd_base_user)
  * [`nocodb.auth.delete_base_user`](#nocodbauthdelete_base_user)
  * [`nocodb.auth.list_base_users`](#nocodbauthlist_base_users)
  * [`nocodb.auth.resend_invite_user`](#nocodbauthresend_invite_user)
  * [`nocodb.auth.update_base_user`](#nocodbauthupdate_base_user)
  * [`nocodb.base.calculate_cost`](#nocodbbasecalculate_cost)
  * [`nocodb.base.check_empty_filters`](#nocodbbasecheck_empty_filters)
  * [`nocodb.base.create_new_base`](#nocodbbasecreate_new_base)
  * [`nocodb.base.create_shared_base`](#nocodbbasecreate_shared_base)
  * [`nocodb.base.create_ui_acl`](#nocodbbasecreate_ui_acl)
  * [`nocodb.base.delete_shared_base`](#nocodbbasedelete_shared_base)
  * [`nocodb.base.duplicate_base_post`](#nocodbbaseduplicate_base_post)
  * [`nocodb.base.duplicate_post`](#nocodbbaseduplicate_post)
  * [`nocodb.base.get_info`](#nocodbbaseget_info)
  * [`nocodb.base.get_info_by_id`](#nocodbbaseget_info_by_id)
  * [`nocodb.base.get_shared_base`](#nocodbbaseget_shared_base)
  * [`nocodb.base.get_ui_acl`](#nocodbbaseget_ui_acl)
  * [`nocodb.base.list_audits_in_base`](#nocodbbaselist_audits_in_base)
  * [`nocodb.base.list_bases`](#nocodbbaselist_bases)
  * [`nocodb.base.meta_diff_get`](#nocodbbasemeta_diff_get)
  * [`nocodb.base.remove_base`](#nocodbbaseremove_base)
  * [`nocodb.base.sync_meta_diff`](#nocodbbasesync_meta_diff)
  * [`nocodb.base.update_base_meta`](#nocodbbaseupdate_base_meta)
  * [`nocodb.base.update_meta_user`](#nocodbbaseupdate_meta_user)
  * [`nocodb.base.update_shared_base`](#nocodbbaseupdate_shared_base)
  * [`nocodb.db_table.create_new_table`](#nocodbdb_tablecreate_new_table)
  * [`nocodb.db_table.delete_by_table_id`](#nocodbdb_tabledelete_by_table_id)
  * [`nocodb.db_table.duplicate_table_post`](#nocodbdb_tableduplicate_table_post)
  * [`nocodb.db_table.list_tables`](#nocodbdb_tablelist_tables)
  * [`nocodb.db_table.read_by_table_id`](#nocodbdb_tableread_by_table_id)
  * [`nocodb.db_table.update_meta`](#nocodbdb_tableupdate_meta)
  * [`nocodb.db_table.update_table_order`](#nocodbdb_tableupdate_table_order)
  * [`nocodb.db_table_column.bulk_create_update`](#nocodbdb_table_columnbulk_create_update)
  * [`nocodb.db_table_column.create_new_column`](#nocodbdb_table_columncreate_new_column)
  * [`nocodb.db_table_column.delete_by_column_id`](#nocodbdb_table_columndelete_by_column_id)
  * [`nocodb.db_table_column.get_column_by_id`](#nocodbdb_table_columnget_column_by_id)
  * [`nocodb.db_table_column.get_table_columns_hash`](#nocodbdb_table_columnget_table_columns_hash)
  * [`nocodb.db_table_column.set_primary_value`](#nocodbdb_table_columnset_primary_value)
  * [`nocodb.db_table_column.update_by_column_id`](#nocodbdb_table_columnupdate_by_column_id)
  * [`nocodb.db_table_filter.create_view_filter`](#nocodbdb_table_filtercreate_view_filter)
  * [`nocodb.db_table_filter.delete_by_id`](#nocodbdb_table_filterdelete_by_id)
  * [`nocodb.db_table_filter.get_by_id`](#nocodbdb_table_filterget_by_id)
  * [`nocodb.db_table_filter.get_children`](#nocodbdb_table_filterget_children)
  * [`nocodb.db_table_filter.get_view_data`](#nocodbdb_table_filterget_view_data)
  * [`nocodb.db_table_filter.update_by_id`](#nocodbdb_table_filterupdate_by_id)
  * [`nocodb.db_table_sort.delete_by_id`](#nocodbdb_table_sortdelete_by_id)
  * [`nocodb.db_table_sort.get_all_sorts`](#nocodbdb_table_sortget_all_sorts)
  * [`nocodb.db_table_sort.get_sort_by_id`](#nocodbdb_table_sortget_sort_by_id)
  * [`nocodb.db_table_sort.update_sort_by_id`](#nocodbdb_table_sortupdate_sort_by_id)
  * [`nocodb.db_table_sort.update_view_sort`](#nocodbdb_table_sortupdate_view_sort)
  * [`nocodb.db_table_webhook.create_hook`](#nocodbdb_table_webhookcreate_hook)
  * [`nocodb.db_table_webhook.delete_by_id`](#nocodbdb_table_webhookdelete_by_id)
  * [`nocodb.db_table_webhook.get_sample_payload`](#nocodbdb_table_webhookget_sample_payload)
  * [`nocodb.db_table_webhook.list_table_hooks`](#nocodbdb_table_webhooklist_table_hooks)
  * [`nocodb.db_table_webhook.test_hook_create`](#nocodbdb_table_webhooktest_hook_create)
  * [`nocodb.db_table_webhook.update_by_id`](#nocodbdb_table_webhookupdate_by_id)
  * [`nocodb.db_table_webhook_filter.create_new_filter`](#nocodbdb_table_webhook_filtercreate_new_filter)
  * [`nocodb.db_table_webhook_filter.get_hook_filter`](#nocodbdb_table_webhook_filterget_hook_filter)
  * [`nocodb.db_table_webhook_logs.list`](#nocodbdb_table_webhook_logslist)
  * [`nocodb.db_view.create_form_view`](#nocodbdb_viewcreate_form_view)
  * [`nocodb.db_view.create_gallery_view`](#nocodbdb_viewcreate_gallery_view)
  * [`nocodb.db_view.create_grid_view`](#nocodbdb_viewcreate_grid_view)
  * [`nocodb.db_view.create_kanban_view`](#nocodbdb_viewcreate_kanban_view)
  * [`nocodb.db_view.create_map_view`](#nocodbdb_viewcreate_map_view)
  * [`nocodb.db_view.delete_view_by_id`](#nocodbdb_viewdelete_view_by_id)
  * [`nocodb.db_view.get_form_by_id`](#nocodbdb_viewget_form_by_id)
  * [`nocodb.db_view.get_gallery_view`](#nocodbdb_viewget_gallery_view)
  * [`nocodb.db_view.get_map_view_by_id`](#nocodbdb_viewget_map_view_by_id)
  * [`nocodb.db_view.hide_all_columns`](#nocodbdb_viewhide_all_columns)
  * [`nocodb.db_view.kanban_view_get`](#nocodbdb_viewkanban_view_get)
  * [`nocodb.db_view.list_grid_columns`](#nocodbdb_viewlist_grid_columns)
  * [`nocodb.db_view.list_table_views`](#nocodbdb_viewlist_table_views)
  * [`nocodb.db_view.show_all_columns`](#nocodbdb_viewshow_all_columns)
  * [`nocodb.db_view.update_by_id`](#nocodbdb_viewupdate_by_id)
  * [`nocodb.db_view.update_form_column`](#nocodbdb_viewupdate_form_column)
  * [`nocodb.db_view.update_form_view`](#nocodbdb_viewupdate_form_view)
  * [`nocodb.db_view.update_gallery_view_data`](#nocodbdb_viewupdate_gallery_view_data)
  * [`nocodb.db_view.update_grid_column_patch`](#nocodbdb_viewupdate_grid_column_patch)
  * [`nocodb.db_view.update_grid_view`](#nocodbdb_viewupdate_grid_view)
  * [`nocodb.db_view.update_kanban_view`](#nocodbdb_viewupdate_kanban_view)
  * [`nocodb.db_view.update_map_view_data`](#nocodbdb_viewupdate_map_view_data)
  * [`nocodb.db_view_column.create_new_column`](#nocodbdb_view_columncreate_new_column)
  * [`nocodb.db_view_column.list_by_view`](#nocodbdb_view_columnlist_by_view)
  * [`nocodb.db_view_column.update_column`](#nocodbdb_view_columnupdate_column)
  * [`nocodb.db_view_share.create_shared_view`](#nocodbdb_view_sharecreate_shared_view)
  * [`nocodb.db_view_share.delete_shared_view`](#nocodbdb_view_sharedelete_shared_view)
  * [`nocodb.db_view_share.list_shared_views`](#nocodbdb_view_sharelist_shared_views)
  * [`nocodb.db_view_share.update_shared_view`](#nocodbdb_view_shareupdate_shared_view)
  * [`nocodb.plugin.get_data_by_id`](#nocodbpluginget_data_by_id)
  * [`nocodb.plugin.get_status`](#nocodbpluginget_status)
  * [`nocodb.plugin.list_all_plugins`](#nocodbpluginlist_all_plugins)
  * [`nocodb.plugin.test_configuration_post`](#nocodbplugintest_configuration_post)
  * [`nocodb.plugin.update_by_id`](#nocodbpluginupdate_by_id)
  * [`nocodb.plugin.webhook_list_plugins`](#nocodbpluginwebhook_list_plugins)
  * [`nocodb.public.calendar_view_count_by_date`](#nocodbpubliccalendar_view_count_by_date)
  * [`nocodb.public.calendar_view_list_shared_rows`](#nocodbpubliccalendar_view_list_shared_rows)
  * [`nocodb.public.create_shared_view_row`](#nocodbpubliccreate_shared_view_row)
  * [`nocodb.public.list_nested_data`](#nocodbpubliclist_nested_data)
  * [`nocodb.public.list_shared_rows`](#nocodbpubliclist_shared_rows)
  * [`nocodb.public.list_shared_view_rows_group_by`](#nocodbpubliclist_shared_view_rows_group_by)
  * [`nocodb.public.nested_data_relation_list`](#nocodbpublicnested_data_relation_list)
  * [`nocodb.public.rows_export_type`](#nocodbpublicrows_export_type)
  * [`nocodb.public.shared_base_meta_get`](#nocodbpublicshared_base_meta_get)
  * [`nocodb.public.shared_erd_meta_get`](#nocodbpublicshared_erd_meta_get)
  * [`nocodb.public.shared_view_group_data_list`](#nocodbpublicshared_view_group_data_list)
  * [`nocodb.public.view_meta_get`](#nocodbpublicview_meta_get)
  * [`nocodb.source.base_id_sources_list`](#nocodbsourcebase_id_sources_list)
  * [`nocodb.source.create_erd_share`](#nocodbsourcecreate_erd_share)
  * [`nocodb.source.create_new_source`](#nocodbsourcecreate_new_source)
  * [`nocodb.source.create_sql_view`](#nocodbsourcecreate_sql_view)
  * [`nocodb.source.create_table`](#nocodbsourcecreate_table)
  * [`nocodb.source.delete_details`](#nocodbsourcedelete_details)
  * [`nocodb.source.delete_erd_share`](#nocodbsourcedelete_erd_share)
  * [`nocodb.source.get_details`](#nocodbsourceget_details)
  * [`nocodb.source.get_meta_diff`](#nocodbsourceget_meta_diff)
  * [`nocodb.source.get_tables`](#nocodbsourceget_tables)
  * [`nocodb.source.sync_meta_diff`](#nocodbsourcesync_meta_diff)
  * [`nocodb.source.update_details`](#nocodbsourceupdate_details)
  * [`nocodb.storage.upload_attachment`](#nocodbstorageupload_attachment)
  * [`nocodb.storage.upload_by_url`](#nocodbstorageupload_by_url)
  * [`nocodb.table_records.create_new_record`](#nocodbtable_recordscreate_new_record)
  * [`nocodb.table_records.delete_by_array`](#nocodbtable_recordsdelete_by_array)
  * [`nocodb.table_records.get_count`](#nocodbtable_recordsget_count)
  * [`nocodb.table_records.link_records_post`](#nocodbtable_recordslink_records_post)
  * [`nocodb.table_records.list`](#nocodbtable_recordslist)
  * [`nocodb.table_records.list_linked_records`](#nocodbtable_recordslist_linked_records)
  * [`nocodb.table_records.read_by_id`](#nocodbtable_recordsread_by_id)
  * [`nocodb.table_records.unlink_records`](#nocodbtable_recordsunlink_records)
  * [`nocodb.table_records.update_patch_table_records`](#nocodbtable_recordsupdate_patch_table_records)
  * [`nocodb.utils.clear_noco_cache`](#nocodbutilsclear_noco_cache)
  * [`nocodb.utils.count_comments`](#nocodbutilscount_comments)
  * [`nocodb.utils.create_new_comment_row`](#nocodbutilscreate_new_comment_row)
  * [`nocodb.utils.get_all_noco_cache`](#nocodbutilsget_all_noco_cache)
  * [`nocodb.utils.get_app_info`](#nocodbutilsget_app_info)
  * [`nocodb.utils.list_comments`](#nocodbutilslist_comments)
  * [`nocodb.utils.make_axios_request`](#nocodbutilsmake_axios_request)
  * [`nocodb.utils.select_connection_post`](#nocodbutilsselect_connection_post)
  * [`nocodb.utils.test_db_connection`](#nocodbutilstest_db_connection)
  * [`nocodb.utils.update_audit_comment`](#nocodbutilsupdate_audit_comment)
  * [`nocodb.utils.update_audit_row`](#nocodbutilsupdate_audit_row)

<!-- tocstop -->

## Requirements<a id="requirements"></a>

Python >=3.7

## Installation<a id="installation"></a>
<div align="center">
  <a href="https://konfigthis.com/sdk-sign-up?company=NocoDB&language=Python">
    <img src="https://raw.githubusercontent.com/konfig-dev/brand-assets/HEAD/cta-images/python-cta.png" width="70%">
  </a>
</div>

## Getting Started<a id="getting-started"></a>

```python
from pprint import pprint
from noco_db_python_sdk import NocoDb, ApiException

nocodb = NocoDb(
)

try:
    # Create API Token
    create_in_base_response = nocodb.api_token.create_in_base(
        base_id="string",
        description="This API Token is for ABC application",
        xc_auth="string_example",
    )
    print(create_in_base_response)
except ApiException as e:
    print("Exception when calling APITokenApi.create_in_base: %s\n" % e)
    pprint(e.body)
    if e.status == 400:
        pprint(e.body["msg"])
    pprint(e.headers)
    pprint(e.status)
    pprint(e.reason)
    pprint(e.round_trip_time)
```

## Async<a id="async"></a>

`async` support is available by prepending `a` to any method.

```python

import asyncio
from pprint import pprint
from noco_db_python_sdk import NocoDb, ApiException

nocodb = NocoDb(
)

async def main():
    try:
        # Create API Token
        create_in_base_response = await nocodb.api_token.acreate_in_base(
            base_id="string",
            description="This API Token is for ABC application",
            xc_auth="string_example",
        )
        print(create_in_base_response)
    except ApiException as e:
        print("Exception when calling APITokenApi.create_in_base: %s\n" % e)
        pprint(e.body)
        if e.status == 400:
            pprint(e.body["msg"])
        pprint(e.headers)
        pprint(e.status)
        pprint(e.reason)
        pprint(e.round_trip_time)

asyncio.run(main())
```

## Raw HTTP Response<a id="raw-http-response"></a>

To access raw HTTP response values, use the `.raw` namespace.

```python
from pprint import pprint
from noco_db_python_sdk import NocoDb, ApiException

nocodb = NocoDb(
)

try:
    # Create API Token
    create_in_base_response = nocodb.api_token.raw.create_in_base(
        base_id="string",
        description="This API Token is for ABC application",
        xc_auth="string_example",
    )
    pprint(create_in_base_response.body)
    pprint(create_in_base_response.body["description"])
    pprint(create_in_base_response.body["id"])
    pprint(create_in_base_response.body["fk_user_id"])
    pprint(create_in_base_response.body["token"])
    pprint(create_in_base_response.headers)
    pprint(create_in_base_response.status)
    pprint(create_in_base_response.round_trip_time)
except ApiException as e:
    print("Exception when calling APITokenApi.create_in_base: %s\n" % e)
    pprint(e.body)
    if e.status == 400:
        pprint(e.body["msg"])
    pprint(e.headers)
    pprint(e.status)
    pprint(e.reason)
    pprint(e.round_trip_time)
```


## Reference<a id="reference"></a>
### `nocodb.api_token.create_in_base`<a id="nocodbapi_tokencreate_in_base"></a>

Create API Token in a base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
create_in_base_response = nocodb.api_token.create_in_base(
    base_id="string",
    description="This API Token is for ABC application",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### description: `str`<a id="description-str"></a>

Description of the API token

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### ⚙️ Request Body<a id="⚙️-request-body"></a>

[`ApiTokenReq`](./noco_db_python_sdk/type/api_token_req.py)
#### 🔄 Return<a id="🔄-return"></a>

[`ApiToken`](./noco_db_python_sdk/pydantic/api_token.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/api-tokens` `post`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.api_token.delete_in_base`<a id="nocodbapi_tokendelete_in_base"></a>

Delete the given API Token in base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
delete_in_base_response = nocodb.api_token.delete_in_base(
    base_id="string",
    token="DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### token: `str`<a id="token-str"></a>

API Token

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/api-tokens/{token}` `delete`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.api_token.list_in_base`<a id="nocodbapi_tokenlist_in_base"></a>

List API Tokens in the given base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
list_in_base_response = nocodb.api_token.list_in_base(
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🔄 Return<a id="🔄-return"></a>

[`ApiTokenList`](./noco_db_python_sdk/pydantic/api_token_list.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/api-tokens` `get`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.auth.add_base_user`<a id="nocodbauthadd_base_user"></a>

Create a user and add it to the given base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
add_base_user_response = nocodb.auth.add_base_user(
    email="user@example.com",
    roles="owner",
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### email: `str`<a id="email-str"></a>

Base User Email

##### roles: `str`<a id="roles-str"></a>

Base User Role

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### ⚙️ Request Body<a id="⚙️-request-body"></a>

[`ProjectUserReq`](./noco_db_python_sdk/type/project_user_req.py)
#### 🔄 Return<a id="🔄-return"></a>

[`AuthAddBaseUserResponse`](./noco_db_python_sdk/pydantic/auth_add_base_user_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/users` `post`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.auth.delete_base_user`<a id="nocodbauthdelete_base_user"></a>

Delete a given user in a given base. Exclusive for Super Admin. Access with API Tokens will be blocked.

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
delete_base_user_response = nocodb.auth.delete_base_user(
    base_id="string",
    user_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### user_id: [`Id`](./noco_db_python_sdk/type/.py)<a id="user_id-idnoco_db_python_sdktypepy"></a>

Unique User ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🔄 Return<a id="🔄-return"></a>

[`AuthDeleteBaseUserResponse`](./noco_db_python_sdk/pydantic/auth_delete_base_user_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/users/{userId}` `delete`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.auth.list_base_users`<a id="nocodbauthlist_base_users"></a>

List all users in the given base.

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
list_base_users_response = nocodb.auth.list_base_users(
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🔄 Return<a id="🔄-return"></a>

[`AuthListBaseUsersResponse`](./noco_db_python_sdk/pydantic/auth_list_base_users_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/users` `get`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.auth.resend_invite_user`<a id="nocodbauthresend_invite_user"></a>

Resend Invitation to a specific user

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
resend_invite_user_response = nocodb.auth.resend_invite_user(
    base_id="string",
    user_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### user_id: [`Id`](./noco_db_python_sdk/type/.py)<a id="user_id-idnoco_db_python_sdktypepy"></a>

Unique User ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🔄 Return<a id="🔄-return"></a>

[`AuthResendInviteUserResponse`](./noco_db_python_sdk/pydantic/auth_resend_invite_user_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/users/{userId}/resend-invite` `post`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.auth.update_base_user`<a id="nocodbauthupdate_base_user"></a>

Update a given user in a given base. Exclusive for Super Admin. Access with API Tokens will be blocked.

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
update_base_user_response = nocodb.auth.update_base_user(
    email="user@example.com",
    roles="owner",
    base_id="string",
    user_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### email: `str`<a id="email-str"></a>

Base User Email

##### roles: `str`<a id="roles-str"></a>

Base User Role

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### user_id: [`Id`](./noco_db_python_sdk/type/.py)<a id="user_id-idnoco_db_python_sdktypepy"></a>

Unique User ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### ⚙️ Request Body<a id="⚙️-request-body"></a>

[`ProjectUserReq`](./noco_db_python_sdk/type/project_user_req.py)
#### 🔄 Return<a id="🔄-return"></a>

[`AuthUpdateBaseUserResponse`](./noco_db_python_sdk/pydantic/auth_update_base_user_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/users/{userId}` `patch`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.calculate_cost`<a id="nocodbbasecalculate_cost"></a>

Calculate the Base Cost

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
calculate_cost_response = nocodb.base.calculate_cost(
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/cost` `get`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.check_empty_filters`<a id="nocodbbasecheck_empty_filters"></a>

Check if a base contains empty and null filters. Used in `Show NULL and EMPTY in Filter` in Base Setting.

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
check_empty_filters_response = nocodb.base.check_empty_filters(
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/has-empty-or-null-filters` `get`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.create_new_base`<a id="nocodbbasecreate_new_base"></a>

Create a new base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
create_new_base_response = nocodb.base.create_new_base(
    body=None,
    title="My Base",
    description="This is my base description",
    sources=[
        {
            "alias": "My Source",
            "inflection_column": "camelize",
            "inflection_table": "camelize",
            "is_meta": True,
            "type": "mysql",
        }
    ],
    color="#24716E",
    status=None,
    type="database",
    linked_db_project_ids=[
        "string_example"
    ],
    meta=None,
    external=False,
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### title: `str`<a id="title-str"></a>

Base Title

##### description: `str`<a id="description-str"></a>

Base Description

##### sources: List[`BaseReq`]<a id="sources-listbasereq"></a>

Array of Bases

##### color: `str`<a id="color-str"></a>

Primary Theme Color

##### status: `StringOrNull`<a id="status-stringornull"></a>

##### type: `str`<a id="type-str"></a>

##### linked_db_project_ids: [`ProjectReqLinkedDbProjectIds`](./noco_db_python_sdk/type/project_req_linked_db_project_ids.py)<a id="linked_db_project_ids-projectreqlinkeddbprojectidsnoco_db_python_sdktypeproject_req_linked_db_project_idspy"></a>

##### meta: `Meta`<a id="meta-meta"></a>

##### external: `bool`<a id="external-bool"></a>

If true, the base will us an external database else it will use the root database

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### ⚙️ Request Body<a id="⚙️-request-body"></a>

[`BaseCreateNewBaseRequest`](./noco_db_python_sdk/type/base_create_new_base_request.py)
#### 🔄 Return<a id="🔄-return"></a>

[`Base`](./noco_db_python_sdk/pydantic/base.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases` `post`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.create_shared_base`<a id="nocodbbasecreate_shared_base"></a>

Create Base Shared Base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
create_shared_base_response = nocodb.base.create_shared_base(
    base_id="string",
    password="password123",
    roles="editor",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### password: `str`<a id="password-str"></a>

Password to protect the base

##### roles: `str`<a id="roles-str"></a>

The role given the target user

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### ⚙️ Request Body<a id="⚙️-request-body"></a>

[`SharedBaseReq`](./noco_db_python_sdk/type/shared_base_req.py)
#### 🔄 Return<a id="🔄-return"></a>

[`BaseCreateSharedBaseResponse`](./noco_db_python_sdk/pydantic/base_create_shared_base_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/shared` `post`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.create_ui_acl`<a id="nocodbbasecreate_ui_acl"></a>

Hide / show views based on user role

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
create_ui_acl_response = nocodb.base.create_ui_acl(
    body=[{
}],
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

##### requestBody: [`VisibilityRuleReq`](./noco_db_python_sdk/type/visibility_rule_req.py)<a id="requestbody-visibilityrulereqnoco_db_python_sdktypevisibility_rule_reqpy"></a>

#### 🔄 Return<a id="🔄-return"></a>

[`BaseCreateUiAclResponse`](./noco_db_python_sdk/pydantic/base_create_ui_acl_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/visibility-rules` `post`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.delete_shared_base`<a id="nocodbbasedelete_shared_base"></a>

Delete Base Shared Base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
delete_shared_base_response = nocodb.base.delete_shared_base(
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/shared` `delete`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.duplicate_base_post`<a id="nocodbbaseduplicate_base_post"></a>

Duplicate a base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
duplicate_base_post_response = nocodb.base.duplicate_base_post(
    base_id="string",
    options={
    },
    base={},
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### options: [`BaseDuplicateBasePostRequestOptions`](./noco_db_python_sdk/type/base_duplicate_base_post_request_options.py)<a id="options-baseduplicatebasepostrequestoptionsnoco_db_python_sdktypebase_duplicate_base_post_request_optionspy"></a>


##### base: `Dict[str, Union[bool, date, datetime, dict, float, int, list, str, None]]`<a id="base-dictstr-unionbool-date-datetime-dict-float-int-list-str-none"></a>

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### ⚙️ Request Body<a id="⚙️-request-body"></a>

[`BaseDuplicateBasePostRequest`](./noco_db_python_sdk/type/base_duplicate_base_post_request.py)
#### 🔄 Return<a id="🔄-return"></a>

[`BaseDuplicateBasePostResponse`](./noco_db_python_sdk/pydantic/base_duplicate_base_post_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/duplicate/{baseId}` `post`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.duplicate_post`<a id="nocodbbaseduplicate_post"></a>

Duplicate a base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
duplicate_post_response = nocodb.base.duplicate_post(
    base_id="string",
    options={
    },
    base={},
    xc_auth="string_example",
    source_id="string",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### options: [`BaseDuplicatePostRequestOptions`](./noco_db_python_sdk/type/base_duplicate_post_request_options.py)<a id="options-baseduplicatepostrequestoptionsnoco_db_python_sdktypebase_duplicate_post_request_optionspy"></a>


##### base: `Dict[str, Union[bool, date, datetime, dict, float, int, list, str, None]]`<a id="base-dictstr-unionbool-date-datetime-dict-float-int-list-str-none"></a>

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

##### source_id: `Id`<a id="source_id-id"></a>

Unique Source ID

#### ⚙️ Request Body<a id="⚙️-request-body"></a>

[`BaseDuplicatePostRequest`](./noco_db_python_sdk/type/base_duplicate_post_request.py)
#### 🔄 Return<a id="🔄-return"></a>

[`BaseDuplicatePostResponse`](./noco_db_python_sdk/pydantic/base_duplicate_post_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/duplicate/{baseId}/{sourceId}` `post`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.get_info`<a id="nocodbbaseget_info"></a>

Get the info of a given base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
get_info_response = nocodb.base.get_info(
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🔄 Return<a id="🔄-return"></a>

[`Base`](./noco_db_python_sdk/pydantic/base.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}` `get`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.get_info_by_id`<a id="nocodbbaseget_info_by_id"></a>

Get info such as node version, arch, platform, is docker, rootdb and package version of a given base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
get_info_by_id_response = nocodb.base.get_info_by_id(
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🔄 Return<a id="🔄-return"></a>

[`BaseGetInfoByIdResponse`](./noco_db_python_sdk/pydantic/base_get_info_by_id_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/info` `get`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.get_shared_base`<a id="nocodbbaseget_shared_base"></a>

Get Base Shared Base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
get_shared_base_response = nocodb.base.get_shared_base(
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🔄 Return<a id="🔄-return"></a>

[`BaseGetSharedBaseResponse`](./noco_db_python_sdk/pydantic/base_get_shared_base_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/shared` `get`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.get_ui_acl`<a id="nocodbbaseget_ui_acl"></a>

Hide / show views based on user role

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
get_ui_acl_response = nocodb.base.get_ui_acl(
    base_id="string",
    include_m2_m=True,
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### include_m2_m: `bool`<a id="include_m2_m-bool"></a>

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🔄 Return<a id="🔄-return"></a>

[`BaseGetUiAclResponse`](./noco_db_python_sdk/pydantic/base_get_ui_acl_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/visibility-rules` `get`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.list_audits_in_base`<a id="nocodbbaselist_audits_in_base"></a>

List all audit data in the given base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
list_audits_in_base_response = nocodb.base.list_audits_in_base(
    base_id="string",
    offset=0,
    limit=1,
    source_id="string_example",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### offset: `int`<a id="offset-int"></a>

##### limit: `int`<a id="limit-int"></a>

##### source_id: `str`<a id="source_id-str"></a>

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🔄 Return<a id="🔄-return"></a>

[`BaseListAuditsInBaseResponse`](./noco_db_python_sdk/pydantic/base_list_audits_in_base_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/audits` `get`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.list_bases`<a id="nocodbbaselist_bases"></a>

List all base meta data

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
list_bases_response = nocodb.base.list_bases(
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🔄 Return<a id="🔄-return"></a>

[`ProjectList`](./noco_db_python_sdk/pydantic/project_list.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases` `get`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.meta_diff_get`<a id="nocodbbasemeta_diff_get"></a>

Get the meta data difference between NC_DB and external data sources 

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
meta_diff_get_response = nocodb.base.meta_diff_get(
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🔄 Return<a id="🔄-return"></a>

[`BaseMetaDiffGetResponse`](./noco_db_python_sdk/pydantic/base_meta_diff_get_response.py)

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}/meta-diff` `get`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.remove_base`<a id="nocodbbaseremove_base"></a>

Delete the given base

#### 🛠️ Usage<a id="🛠️-usage"></a>

```python
remove_base_response = nocodb.base.remove_base(
    base_id="string",
    xc_auth="string_example",
)
```

#### ⚙️ Parameters<a id="⚙️-parameters"></a>

##### base_id: `Id`<a id="base_id-id"></a>

Unique Base ID

##### xc_auth: `str`<a id="xc_auth-str"></a>

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.

#### 🌐 Endpoint<a id="🌐-endpoint"></a>

`/api/v2/meta/bases/{baseId}` `delete`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

### `nocodb.base.sync_meta_diff`<a id