PyPI version License Python Versions

Note: This is a fork of python-nocodb with extended functionality.

NocoDB is a great Airtable alternative. This client allows python developers to use NocoDB API in a simple way.

📌 Table of Contents

📥 Installation

pip install git+https://github.com/DeepCognition/python-nocodb.git

🔧 Usage

🔑 Client configuration

from nocodb.nocodb import NocoDBProject, APIToken, JWTAuthToken
from nocodb.filters import LikeFilter, EqFilter, And
from nocodb.infra.requests_client import NocoDBRequestsClient
# Usage with API Token
client = NocoDBRequestsClient(
 # Your API Token retrieved from NocoDB conf
 APIToken("YOUR-API-TOKEN"),
 # Your nocodb root path
 "http://localhost:8080"
)
# Usage with JWT Token
client = NocoDBRequestsClient(
 # Your API Token retrieved from NocoDB conf
 JWTAuthToken("your.jwt.token"),
 # Your nocodb root path
 "http://localhost:8080"
)

📊 Project creation

# Example with default database
project_body = {"title": "My new project"}
# Example with Postgresql
project_body = {
 "title": "MyProject",
 "bases": [
 {
 "type": "pg",
 "config": {
 "client": "pg",
 "connection": {
 "host": "localhost",
 "port": "5432",
 "user": "postgres",
 "password": "postgres",
 "database": "postgres"
 },
 "searchPath": [
 "public"
 ]
 },
 "inflection_column": "camelize",
 "inflection_table": "camelize"
 }
 ],
 "external": True
}
project = client.project_create(body=project_body)

Project selection

# Be very carefull with org, project_name and table names
# weird errors from nocodb can arrive if they are wrong
# example: id is not defined...
# probably they will fix that in a future release.
project = NocoDBProject(
 "noco", # org name. noco by default
 "myproject" # project name. Case sensitive!!
)

Table rows operations

table_name = "tablename"
# Retrieve a page of rows from a table
table_rows = client.table_row_list(project, table_name)
# Retrieve the first 1000 rows
table_rows = client.table_row_list(project, table_name, params={'limit': 1000})
# Skip 100 rows
table_rows = client.table_row_list(project, table_name, params={'offset': 100})

first_100_rows = client.table_row_list(project, table_name, params={'limit': 100})
next_100_rows = client.table_row_list(project, table_name, params={'limit': 100, 'offset': 100})
next_100_rows = client.table_row_list(project, table_name, params={'limit': 100, 'offset': 200})

# Filter the query
table_rows = client.table_row_list(project, table_name, LikeFilter("name", "%sam%"))
table_rows = client.table_row_list(project, table_name, And(LikeFilter("name", "%sam%"), EqFilter("age", 26)))
table_rows = client.table_row_list(project, table_name, filter_obj=EqFilter("Id", 100))
# Filter and count rows
count = client.table_count(project, table_name, filter_obj=EqFilter("Id", 100))
# Find one row
table_row = client.table_find_one(project, table_name, filter_obj=EqFilter("Id", 100), params={"sort": "-created_at"})
# Retrieve a single row
row_id = 10
row = client.table_row_detail(project, table_name, row_id)
# Create a new row
row_info = {
 "name": "my thoughts",
 "content": "i'm going to buy samuel a beer 🍻 because I 💚 this module",
 "mood": ":)"
}
client.table_row_create(project, table_name, row_info)
# Update a row
row_id = 2
row_info = {
 "content": "i'm going to buy samuel a new car 🚙 because I 💚 this module",
}
client.table_row_update(project, table_name, row_id, row_info)
# Bulk insert multiple rows
rows_to_insert = [
 {"name": "Alice", "age": 30},
 {"name": "Bob", "age": 28},
]
client.table_row_bulk_insert(project, table_name, rows_to_insert)
# Delete a row (only if you've already bought me a beer)
client.table_row_delete(project, table_name, row_id)

📋 Table Operations

# List all tables in a project
tables = client.table_list(project)
# Read table metadata
table_id = "table_id_from_table_list"
table_metadata = client.table_read(table_id)
# Get detailed table info
table_info = client.table_info(table_id)
# Create a new table
table_body = {
 "table_name": "NewTableName",
 "columns": [
 {
 "title": "Title",
 "column_name": "title",
 "dt": "varchar"
 },
 {
 "title": "Description",
 "column_name": "description",
 "dt": "text"
 }
 ]
}
client.table_create(project, table_body)
# Update a table
table_update_body = {
 "table_name": "UpdatedTableName"
}
client.table_update(table_id, table_update_body)
# Reorder a table
client.table_reorder(table_id, order=2)
# Delete a table
client.table_delete(table_id)

🔢 Table Column Operations

# Create a new column in a table
column_body = {
 "title": "Rating",
 "column_name": "rating",
 "dt": "int"
}
client.table_column_create(table_id, column_body)
# Update a column
column_id = "column_id_from_table_info"
column_update_body = {
 "title": "Score"
}
client.table_column_update(column_id, column_update_body)
# Set a column as primary
client.table_column_set_primary(column_id)
# Delete a column
client.table_column_delete(column_id)

🔍 View Filter Operations

# Create a filter for a view
view_id = "view_id_from_view_list"
filter_body = {
 "comparison_op": "eq",
 "value": "Active",
 "fk_column_id": column_id
}
client.view_filter_create(view_id, filter_body)

👥 Project Users Management

# Get users for a project with pagination
users_page = client.project_users_list(
 project, 
 page=1, 
 page_size=25, 
 include_roles=True
)
# Get all users for a project (automatically handles pagination)
all_users = client.project_users_list_all(
 project, 
 include_roles=True
)

🔎 Available filters

Combining filters using Logical operations

from nocodb import filters
# Basic filters...
nick_filter = filters.EqFilter("nickname", "elchicodepython")
country_filter = filters.EqFilter("country", "es")
girlfriend_code = filters.EqFilter("gfcode", "404")
current_mood_code = filters.EqFilter("moodcode", "418")
# Combining filters using logical filters
or_filter = filters.Or(nick_filter, country_filter)
and_filter = filters.And(girlfriend_code, current_mood_code)
# Negating filters with a Not filter
not_me = filters.Not(filters.EqFilter("nickname", "elchicodepython"))
# You can also combine combinations
or_combined_filter = filters.Or(or_filter, and_filter)
and_combined_filter = filters.And(or_filter, and_filter)

Using custom filters

from nocodb.filters.factory import basic_filter_class_factory
BasicFilter = basic_filter_class_factory('=')
table_rows = client.table_row_list(project, table_name, BasicFilter('age', '16'))

from nocodb.filters.raw_filter import RawFilter
table_rows = client.table_row_list(project, table_name, RawFilter('(birthday,eq,exactDate,2023年06月01日)'))

from nocodb.filters.factory import raw_template_filter_class_factory
BirthdayDateFilter = raw_template_filter_class_factory('(birthday,eq,exactDate,{})')
ExactDateEqFilter = raw_template_filter_class_factory('({},eq,exactDate,{})')
ExactDateOpFilter = raw_template_filter_class_factory('({},{op},exactDate,{})')
table_rows = client.table_row_list(project, table_name, BirthdayDateFilter('2023-06-01'))
table_rows = client.table_row_list(project, table_name, ExactDateEqFilter('column', '2023-06-01'))
table_rows = client.table_row_list(project, table_name, ExactDateOpFilter('column', '2023-06-01', op='eq'))

Author notes

📋 Version Information

👨‍💻 Contributors

Original Authors

Fork Maintainer