【ノーコード】CouchDB のデータを Google スプレッドシートにインポートする方法

CData API Server は、CouchDB をREST API(OData) として公開することによりWeb サービスから接続することを可能にします。Google スプレッドシートでは、ImportData 関数を使ってWeb サービスデータをSCV フォーマットで取得することができます。次の手順で Google スプレッドシートでImportData 関数を使ってCouchDB のデータ にアクセスする方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなCouchDB OData サービスを作成していきましょう。

CouchDB への接続

Google スプレッドシートからCouchDB のデータを操作するには、まずCouchDB への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「CouchDB」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、CouchDB への接続設定を行っていきましょう！

5. Apache CouchDB 接続プロパティの取得・設定方法

   それでは、Apache CouchDB に接続していきましょう。Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984

   ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするためにCData 製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

   Apache CouchDB への認証

   続いて、認証方法を設定しましょう。CData 製品では、3種類の認証をサポートしています。

   • Basic：基本的なユーザー名 / パスワード認証
   • JWT：JWT 認証
   • None：パブリックなデータベースへの匿名アクセス

   Basic 認証

   データに接続するには、以下のプロパティを設定してください。

   • AuthScheme：Basic
   • User：認証に使用されるApache CouchDB ユーザーアカウント
   • Password：認証するユーザーに関連付けられたApache CouchDB パスワード

   その他の認証方法については、ヘルプドキュメントの「接続の確立」セクションをご確認ください。

6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Apache CouchDB 接続プロパティの取得・設定方法

それでは、Apache CouchDB に接続していきましょう。Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984

ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするためにCData 製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

Apache CouchDB への認証

続いて、認証方法を設定しましょう。CData 製品では、3種類の認証をサポートしています。

• Basic：基本的なユーザー名 / パスワード認証
• JWT：JWT 認証
• None：パブリックなデータベースへの匿名アクセス

Basic 認証

データに接続するには、以下のプロパティを設定してください。

• AuthScheme：Basic
• User：認証に使用されるApache CouchDB ユーザーアカウント
• Password：認証するユーザーに関連付けられたApache CouchDB パスワード

その他の認証方法については、ヘルプドキュメントの「接続の確立」セクションをご確認ください。

API Server のユーザー設定

次に、API Server 経由でCouchDB にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

CouchDB 用のAPI エンドポイントの作成

ユーザーを作成したら、CouchDB のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でCouchDB への接続を設定してユーザーを作成し、API Server でCouchDB データのAPI を追加しました。これで、OData 形式のCouchDB データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

作成したAPI にGoogle シートから接続

1. 次にGoogle Sheet からの接続のために、認証トークンをクエリ文字列で渡せるようにします。
   クエリ文字列パラメータとして認証トークンを使用する HTTP フォームポストデータ、もしくはクエリパラメータの一部として提供される_@authtoken_ パラメータの値として認証トークンを指定することができます。ただし、デフォルトではAPI Server はクエリ文字列パラメータにおいて認証トークンを渡すことをサポートしていません。 settings.cfg のアプリケーションセクションにて、次のオプションを設定することで有効化できます。クエリ文字列パラメータとして認証トークンを使用する を参照してください。
2. エンドポイントURL をAPI Server が自動生成するAPI ドキュメントからコピーします。authtoken はAPI Server の［ユーザー］を作成し、生成されたトークンを使います。

3. 新しいGoogle スプレッドシートで、=ImportData() 関数をつかって、公開されたデータソースからCSV ファイルでデータをリクエストします。このサンプルでは、Movies テーブル全体をリクエストします。 Google は定期的に関数の結果を更新し、シートが最新のデータを保有している状態に保ちます。次のように関すを設定してみます。:

   =ImportData("https://your-server/api.rsc/Movies?@csv&@authtoken=your-authtoken")