本記事はNECソリューションイノベータAdventCalendar 2022の12/12の記事です。
NocoDBとは
最近、Excelを扱う感覚でデータベースを管理できるノーコードツールが流行しており、海外ではAirtable、国内ではkintoneなどのクラウドサービスが人気です。NocoDBはこのAirtableのOSS版のソフトウェアになります。OSSといってもデータの管理のしやすさ、APIの自動作成などAirtableの基本機能を備えており、Githubのスターが3万以上ある人気ソフトウェアです。
参考まで公式の画像イメージを以下に記載します。
NocoDBの利用ケース
私はWebアプリを開発する機会が多いのですが、データベースを作成しつつAPIが自動作成できるため、バックエンド開発を省力化できるという点で開発初期に作るようなプロトタイプ開発と相性がいいと感じています。またクラウドサービスと比較してNocoDBが優位と思ったケースです。
- 低コストが求められるケース
- クラウドサービスは従量課金が多く、小さく始めることはできますが逆にデータや利用者が増えていくと費用が増えていくケースがあります。NocoDBは起動するマシンの費用は必要ですがそれ以外の費用が必要ありません。
- データの保存先をプライベートにしたいケース
- クラウドサービス側も十分にセキュリティの考慮がされていますが、まだまだクラウド上に業務データを保存したり、インターネットを通じてアクセスできるという点が導入障壁になるケースがあります。NocoDBはイントラネットなどプライベートネットワークに構築することで経路を制限することができます。
試してみよう
Dockerで試してみたいと思います。nodeスクリプトなど他のパターンもあるみたいなので詳しくはこちらの公式ドキュメントを参考ください。
データベースには最近よく利用するMySQLを利用しました。MySQLとNocoDBを起動するdocker-compose.ymlは以下としました。
version: '2.1'
services:
root_db:
platform: linux/x86_64
image: mysql:latest
volumes:
- db_data:/var/lib/mysql
command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
restart: always
environment:
MYSQL_ROOT_PASSWORD: password
MYSQL_DATABASE: root_db
MYSQL_USER: noco
MYSQL_PASSWORD: password
ports:
- "3306:3306"
healthcheck:
test: [ "CMD", "mysqladmin" ,"ping", "-h", "localhost" ]
timeout: 20s
retries: 10
nocodb:
depends_on:
root_db:
condition: service_healthy
image: nocodb/nocodb:latest
ports:
- "8080:8080"
restart: always
volumes:
- nc_data:/usr/app/data
environment:
NC_DB: "mysql2://root_db:3306?u=noco&p=password&d=root_db"
volumes:
db_data: {}
nc_data: {}
docker-compose up -d で起動したら、ブラウザから http://localhost:8080/dashboard にアクセスします。mysqlの起動タイミング次第でこけることがあるのでその場合はnocodbを再起動してください。
初回はサインアップ画面が表示されるので自分のアカウントを登録しましょう。
登録後にホーム画面に遷移するので「NewProject」からプロジェクトを作成し、テーブルを作成してみます。
「test」というプロジェクトを作成します。
table1というテーブルを作成してみました。
Title というカラムが最初からありますが、Author というカラムを追加してみます。
試しにこのテーブルに2件ほどデータを登録してみました。
このときMySQLにはどういうデータが作成されているのか、mysqlコマンドで見てみます。
docker-compose exec root_db /bin/bash
bash-4.4# mysql -uroot -ppassword
databaseを root_db に切り替えてテーブル一覧を参照すると、NocoDBとして管理しているテーブルが大量に出力されました。その中に table1っぽいテーブルが存在しました。
mysql> use root_db
Reading table information for completion of table and column names
You can turn off this feature to get a quicker startup with -A
Database changed
mysql> show tables;
+--------------------------------+
| Tables_in_root_db |
+--------------------------------+
| nc_acl |
| nc_api_tokens |
| nc_audit |
| nc_audit_v2 |
| nc_bases_v2 |
| nc_col_formula_v2 |
| nc_col_lookup_v2 |
| nc_col_relations_v2 |
| nc_col_rollup_v2 |
| nc_col_select_options_v2 |
| nc_columns_v2 |
| nc_cron |
| nc_d6br__table1 | <= これかな？
| nc_disabled_models_for_role |
| nc_disabled_models_for_role_v2 |
| nc_evolutions |
試しにデータを参照しましたが合ってそうです。created_atやupdated_atなどはシステムとして自動的に作成されるカラムのようです。
mysql> select * from nc_d6br__table1;
+----+--------------+---------------------+---------------------+--------+
| id | title | created_at | updated_at | Author |
+----+--------------+---------------------+---------------------+--------+
| 1 | Hello world1 | 2022-12-10 05:29:54 | 2022-12-10 05:29:58 | hoge |
| 2 | Hello world2 | 2022-12-10 05:30:05 | 2022-12-10 05:30:08 | fuga |
+----+--------------+---------------------+---------------------+--------+
2 rows in set (0.03 sec)
ついでにdescribeも叩いてみます。
mysql> describe nc_d6br__table1;
+------------+--------------+------+-----+-------------------+-----------------------------------------------+
| Field | Type | Null | Key | Default | Extra |
+------------+--------------+------+-----+-------------------+-----------------------------------------------+
| id | int unsigned | NO | PRI | NULL | auto_increment |
| title | varchar(45) | YES | | NULL | |
| created_at | timestamp | YES | | CURRENT_TIMESTAMP | DEFAULT_GENERATED |
| updated_at | timestamp | YES | | CURRENT_TIMESTAMP | DEFAULT_GENERATED on update CURRENT_TIMESTAMP |
| Author | varchar(45) | YES | | NULL | |
+------------+--------------+------+-----+-------------------+-----------------------------------------------+
5 rows in set (0.10 sec)
カラムの型はnocodbでカラムを追加するときのColumn Typeに依存しそうです。（Attachmentとかどうなるか気になりましたが今回はそこまで調べていません）
APIも試してみたいと思います。プロジェクトをクリックし、「Team & Settings」からトークンを発行します。
自動作成されるAPI情報(Swagger)はこちらから参照できます。
swagger ui からトークンを設定し、table1のデータ一覧を実行した結果がこちらになります。
感想
Airtableのようにチャート生成機能やレコード単位のスナップショットなど高機能ではないですが、Excelのような操作性やAPI自動作成はシンプルながら強力なのでいろんなケースに利用できそうです。また、MySQLなど既存データベースを利用するため、本番運用のためにAPI+DBを作成しなおすという場合が発生してもDBは移行できる点がいいと思いました。不安な点としては、複雑なSQLが必要になるような場合や性能が求められるような場合には検証してみないと利用できるか判断ができないなと感じました。