Installation

pip install nocodb

Usage

Client configuration

fromnocodb.nocodbimportNocoDBProject,APIToken,JWTAuthTokenfromnocodb.filtersimportLikeFilter,EqFilter,Andfromnocodb.infra.requests_clientimportNocoDBRequestsClient# Usage with API Tokenclient=NocoDBRequestsClient(# Your API Token retrieved from NocoDB confAPIToken("YOUR-API-TOKEN"),# Your nocodb root path"http://localhost:8080")# Usage with JWT Tokenclient=NocoDBRequestsClient(# Your API Token retrieved from NocoDB confJWTAuthToken("your.jwt.token"),# Your nocodb root path"http://localhost:8080")

Project creation

# Example with default databaseproject_body= {"title":"My new project"}# Example with Postgresqlproject_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 tabletable_rows=client.table_row_list(project,table_name)# Retrieve the first 1000 rowstable_rows=client.table_row_list(project,table_name,params={'limit':1000})# Skip 100 rowstable_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 querytable_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 rowscount=client.table_count(project,table_name,filter_obj=EqFilter("Id",100))# Find one rowtable_row=client.table_find_one(project,table_name,filter_obj=EqFilter("Id",100),params={"sort":"-created_at"})# Retrieve a single rowrow_id=10row=client.table_row_detail(project,table_name,row_id)# Create a new rowrow_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 rowrow_id=2row_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)# Delete a row (only if you've already bought me a beer)client.table_row_delete(project,table_name,row_id)

Available filters

Combining filters using Logical operations

fromnocodbimportfilters# 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 filtersor_filter=filters.Or(nick_filter,country_filter)and_filter=filters.And(girlfriend_code,current_mood_code)# Negating filters with a Not filternot_me=filters.Not(filters.EqFilter("nickname","elchicodepython"))# You can also combine combinationsor_combined_filter=filters.Or(or_filter,and_filter)and_combined_filter=filters.And(or_filter,and_filter)

Using custom filters

fromnocodb.filters.factoryimportbasic_filter_class_factoryBasicFilter=basic_filter_class_factory('=')table_rows=client.table_row_list(project,table_name,BasicFilter('age','16'))

fromnocodb.filters.raw_filterimportRawFiltertable_rows=client.table_row_list(project,table_name,RawFilter('(birthday,eq,exactDate,2023-06-01)'))

fromnocodb.filters.factoryimportraw_template_filter_class_factoryBirthdayDateFilter=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

Contributors