TiDB CloudサーバーレスDriverNode.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 cluster information
   console.log(await conn.execute("show tables"))
   

4. 次のコマンドでプロジェクトを実行します。

   node index.js
   

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

グローバルfetch関数がない Node.js 18.0.0 より前のバージョンを使用している場合は、次の手順で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})