クイック スタート: Node.js 用の Azure Cosmos DB for Apache Cassandra クライアント ライブラリ

1. 空のフォルダーから開始します。

2. 新しいモジュールを初期化します。

   npm init es6 --yes
   

3. ノード パッケージ マネージャー (npm) から cassandra-driver パッケージをインストールします。

   npm install --save cassandra-driver
   

4. index.js ファイルを作成します。

1. 空のディレクトリから開始します。

2. 新しいモジュールを初期化します。

   npm init es6 --yes
   

3. ノード パッケージ マネージャー (npm) から typescript パッケージをインストールします。

   npm install --save-dev typescript
   

4. npm から tsx パッケージをインストールします。

   npm install --save-dev tsx
   

5. npm から cassandra-driver パッケージをインストールします。

   npm install --save cassandra-driver
   

6. コンパイラ (tsc) を使用して TypeScript プロジェクトを初期化します。

   npx tsc --init --target es2017 --module es2022 --moduleResolution nodenext
   

7. index.ts ファイルを作成します。

1. 統合開発環境 (IDE) で index.js ファイルを開きます。

2. cassandra-driver モジュールから次の型をインポートします。

   • cassandra
   • cassandra.Client
   • cassandra.mapping.Mapper
   • cassandra.auth.PlainTextAuthProvider

   import cassandra from 'cassandra-driver';
   
   const { Client } = cassandra;
   const { Mapper } = cassandra.mapping;
   const { PlainTextAuthProvider } = cassandra.auth;
   

3. このガイドで前に収集した資格情報の文字列定数変数を作成します。 変数に username、 password、および contactPointという名前を付けます。

   const username = '<username>';
   const password = '<password>';
   const contactPoint = '<contact-point>';
   

4. Azure Cosmos DB for Apache Cassandra アカウントを作成したリージョンに別の文字列変数を作成します。 この変数に region名前を付けます。

   const region = '<azure-region>';
   

5. 前の手順で指定した資格情報を使用して、新しい PlainTextAuthProvider オブジェクトを作成します。

   let authProvider = new PlainTextAuthProvider(
       username,
       password
   );
   

6. 前の手順で作成した資格情報と構成変数を使用して、 Client オブジェクトを作成します。

   let client = new Client({
       contactPoints: [`${contactPoint}:10350`],
       authProvider: authProvider,
       localDataCenter: region,
       sslOptions: {
           secureProtocol: 'TLSv1_2_method'
       },
   });
   

7. クラスターに非同期接続します。

   await client.connect();
   

8. cosmicworksキースペースとproductテーブルをターゲットとする新しいマッパーを作成します。 マッパー Productに名前を付けます。

   const mapper = new Mapper(client, {
       models: {
           'Product': {
               tables: ['product'],
               keyspace: 'cosmicworks'
           }
       }
   });
   

9. forModel関数とProductマッパー名を使用してマッパー インスタンスを生成します。

   const productMapper = mapper.forModel('Product');
   

1. 統合開発環境 (IDE) で index.ts ファイルを開きます。

2. cassandra-driver モジュールから次の型をインポートします。

   • cassandra.auth
   • cassandra.mapping
   • cassandra.types
   • cassandra.Client
   • cassandra.ClientOptions
   • cassandra.mapping.Mapper
   • cassandra.auth.PlainTextAuthProvider

   import { auth, mapping, types, Client, ClientOptions } from 'cassandra-driver';
   
   const { Mapper } = mapping;
   const { PlainTextAuthProvider } = auth;
   

3. このガイドで前に収集した資格情報の文字列定数変数を作成します。 変数に username、 password、および contactPointという名前を付けます。

   const username: string = '<username>';
   const password: string = '<password>';
   const contactPoint: string = '<contact-point>';
   

4. Azure Cosmos DB for Apache Cassandra アカウントを作成したリージョンに別の文字列変数を作成します。 この変数に region名前を付けます。

   const region: string = '<azure-region>';
   

5. 前の手順で指定した資格情報を使用して、新しい PlainTextAuthProvider オブジェクトを作成します。

   let authProvider = new PlainTextAuthProvider(
       username,
       password
   );
   

6. トランスポート層セキュリティ (TLS) 1.2 プロトコルを使用していることを確認するオプションを含む匿名オブジェクトを作成します。

   let sslOptions = {
       secureProtocol: 'TLSv1_2_method'
   };
   

7. 前の手順で作成した資格情報と構成変数を使用して、 ClientOptions オブジェクトを作成します。

   let clientOptions: ClientOptions = {
       contactPoints: [`${contactPoint}:10350`],
       authProvider: authProvider,
       localDataCenter: region,
       sslOptions: sslOptions
   };
   

8. コンストラクターの Client 変数を使用して、clientOptions オブジェクトを作成します。

   let client = new Client(clientOptions);
   

9. クラスターに非同期接続します。

   await client.connect();
   

10. cosmicworksキースペースとproductテーブルをターゲットとする新しいマッパーを作成します。 マッパー Productに名前を付けます。

    const mapper = new Mapper( client, {
        models: {
            'Product': {
                tables: ['product'],
                keyspace: 'cosmicworks'
            }
        }
    });
    

11. forModel関数とProductマッパー名を使用してマッパー インスタンスを生成します。

    const productMapper = mapper.forModel('Product');
    

1. productという名前の変数に新しいオブジェクトを作成します。

   const product = {
       id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
       name: 'Yamba Surfboard',
       category: 'gear-surf-surfboards',
       quantity: 12,
       price: 850.00,
       clearance: false
   };
   

2. 前の手順で作成したinsert変数を渡すproduct関数を非同期で呼び出します。

   await productMapper.insert(product);
   

1. このガイドで前に作成したテーブルに対応するフィールドを使用して、 Product という名前の新しいインターフェイスを定義します。

   	タイプ
   Id	string
   Name	string
   Category	string
   Quantity	int
   Price	decimal
   Clearance	bool

   interface Product {
       id: string;
       name: string;
       category: string;
       quantity: number;
       price: number;
       clearance: boolean;
   }
   

   ヒント

   Node.jsでは、この型を別のファイルに作成することも、既存のファイルの末尾に作成することもできます。

2. Product型の新しいオブジェクトを作成します。 オブジェクトを product という名前の変数に格納します。

   const product: Product = {
       id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
       name: 'Yamba Surfboard',
       category: 'gear-surf-surfboards',
       quantity: 12,
       price: 850.00,
       clearance: false
   };
   

3. 前の手順で作成したinsert変数を渡すproduct関数を非同期で呼び出します。

   await productMapper.insert(product);
   

1. filterという名前の匿名オブジェクトを作成します。 このオブジェクトには、このガイドで前に作成した製品と同じ値を持つ id という名前のプロパティを含めます。

   const filter = {
       id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'
   };
   

2. get変数を渡すマッパーのfilter関数を呼び出します。 結果を matchedProduct という名前の変数に格納します。

   let matchedProduct = await productMapper.get(filter);
   

1. filterという名前の匿名オブジェクトを作成します。 このオブジェクトには、このガイドで前に作成した製品と同じ値を持つ id という名前のプロパティを含めます。

   const filter = {
       id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'
   };
   

2. get変数を渡すマッパーのfilter関数を呼び出します。 結果を、matchedProduct型のProductという名前の変数に格納します。

   let matchedProduct: Product = await productMapper.get(filter);
   

1. 同じquery フィールドを持つ項目と一致する CQL クエリを使用して、categoryという名前の新しい文字列変数を作成します。

   const query = `
   SELECT
       *
   FROM
       cosmicworks.product
   WHERE
       category = :category
   ALLOW FILTERING
   `;
   

2. paramsという名前の匿名オブジェクトを作成します。 このオブジェクトには、このガイドで前に作成した製品と同じ値を持つ category という名前のプロパティを含めます。

   const params = {
       category: 'gear-surf-surfboards'
   };
   

3. execute変数とquery変数の両方を引数として渡すparams関数を非同期的に呼び出します。 結果の rows プロパティを matchedProducts という名前の変数として格納します。

   let { rows: matchedProducts } = await client.execute(query, params);
   

4. 製品の配列に対して foreach メソッドを呼び出して、クエリ結果を反復処理します。

   matchedProducts.forEach(product => {
       // Do something here with each result
   });
   

1. 同じquery フィールドを持つ項目と一致する CQL クエリを使用して、categoryという名前の新しい文字列変数を作成します。

   const query: string = `
   SELECT
       *
   FROM
       cosmicworks.product
   WHERE
       category = :category
   ALLOW FILTERING
   `;
   

2. paramsという名前の匿名オブジェクトを作成します。 このオブジェクトには、このガイドで前に作成した製品と同じ値を持つ category という名前のプロパティを含めます。

   const params = {
       category: 'gear-surf-surfboards'
   };
   

3. execute変数とquery変数の両方を引数として渡すparams関数を非同期的に呼び出します。 結果を、result型のtypes.ResultSetという名前の変数に格納します。

   let result: types.ResultSet = await client.execute(query, params);
   

4. 結果のrowsプロパティを、matchedProducts型のProduct[]という名前の変数として格納します。

   let matchedProducts: Product[] = result.rows;
   

5. 製品の配列に対して foreach メソッドを呼び出して、クエリ結果を反復処理します。

   matchedProducts.forEach((product: Product) => {
       // Do something here with each result
   });
   

node index.js

npx tsx index.ts