TiDB Cloud Serverless Driver Node.js チュートリアル

このチュートリアルでは、ローカルのNode.jsプロジェクトでTiDB Cloudサーバーレスドライバーを使用する方法について説明します。

注記：

• このドキュメントの手順は、 TiDB Cloud Starterインスタンスに加えて、 TiDB Cloud Essentialインスタンスでも適用できます。
• Cloudflare Workers、Vercel Edge Functions、および Netlify Edge Functions でTiDB Cloudサーバーレス ドライバーを使用する方法については、自動車販売に関する洞察とサンプルリポジトリを確認してください。

始める前に

このステップバイステップのチュートリアルを完了するには、以下のものが必要です。

• Node.js >= 18.0.0。
• npm 、またはお好みのパッケージマネージャーを使用してください。
• TiDB Cloud Starterインスタンス。お持ちでない場合は、 TiDB Cloud Starterインスタンスを作成する。

ステップ1. ローカルのNode.jsプロジェクトを作成する

1. node-exampleという名前のプロジェクトを作成します。

   mkdir node-example
   cd node-example
   

2. npmまたはお好みのパッケージマネージャーを使用して、 TiDB Cloudサーバーレスドライバーをインストールしてください。

   以下のコマンドは、npm を使用したインストールを例として示しています。このコマンドを実行すると、プロジェクトディレクトリ内にnode_modulesディレクトリとpackage.jsonファイルが作成されます。

   npm install @tidbcloud/serverless
   

ステップ2. サーバーレスドライバーを使用する

サーバーレスドライバーは、CommonJSモジュールとESモジュールの両方をサポートしています。以下の手順では、ESモジュールの使用例を示します。

1. TiDB Cloud Starterインスタンスの概要ページで、右上隅の「接続」をクリックし、表示されたダイアログからデータベースの接続文字列を取得します。接続文字列は次のようになります。

   mysql://[username]:[password]@[host]/[database]
   

2. package.jsonファイルで、 type: "module"を追加して ES モジュールを指定します。

   例えば：

   {
     "type": "module",
     "dependencies": {
       "@tidbcloud/serverless": "^0.0.7",
     }
   }
   

3. プロジェクトディレクトリにindex.jsという名前のファイルを作成し、以下のコードを追加してください。

   import { connect } from '@tidbcloud/serverless'
   
   const conn = connect({url: 'mysql://[username]:[password]@[host]/[database]'}) // replace with your TiDB Cloud Starter instance information
   console.log(await conn.execute("show tables"))
   

4. 以下のコマンドでプロジェクトを実行してください。

   node index.js
   

以前のバージョンのNode.jsとの互換性

Node.js 18.0.0 より前のバージョンを使用しており、グローバルなfetch関数がない場合は、以下の手順でfetchを取得できます。

1. fetchを提供するパッケージをインストールしてください。例えばundiciなどです。

   npm install undici
   

2. fetch関数をconnect関数に渡します。

   import { connect } from '@tidbcloud/serverless'
   import { fetch } from 'undici'
   
   const conn = connect({url: 'mysql://[username]:[password]@[host]/[database]',fetch})