ステートメントの実行¶

クエリを非同期に実行する¶

The Snowflake Node.js Driver supports asynchronous queries (that is, queries that return control to the user before the query completes). You can start a query, then use polling to determine when the query has completed. After the query completes, you can read the result set.

非同期クエリを有効にするには、 connection.execute メソッドに asyncExec: true を含めます。

次の例は、 Promise を使用してクエリを非同期に実行する方法を示しています。

let queryId;

// 1. Execute query with asyncExec set to true
await new Promise((resolve) => {
  connection.execute({
    sqlText: "CALL SYSTEM$WAIT(3, 'SECONDS')",
    asyncExec: true,
    complete: async function (err, stmt, rows) {
      queryId = stmt.getQueryId(); // Get the query ID
      resolve();
    }
  });
});

// 2. Get results using the query ID
const statement = await connection.getResultsFromQueryId({ queryId: queryId });
await new Promise((resolve, reject) => {
  const stream = statement.streamRows();
  stream.on('error', err => {
    reject(err);
  });
  stream.on('data', row => {
    console.log(row);
  });
  stream.on('end', () => {
    resolve();
  });
});

また、次の例に示すように、コールバックを使用して非同期クエリを監視することもできます。

1. connection.execute メソッドに asyncExec: true を含めることで、非同期クエリを有効にします。

   CopyExpand

   // 1. Execute query with asyncExec set to true
   connection.execute({
     sqlText: "CALL SYSTEM$WAIT(3, 'SECONDS')",
     asyncExec: true,
     complete: async function (err, stmt, rows) {
       const queryId = stmt.getQueryId();
   
       // 2. Get results using the query ID
       connection.getResultsFromQueryId({
         queryId: queryId,
         complete: async function (err, _stmt, rows) {
           console.log(rows);
         }
       });
     }
   });
   

   Show lessSee more

   Scroll to top

2. 非同期で実行するために送信されたクエリのステータスを確認します。

   CopyExpand

   let queryId;
   
   // 1. Execute query with asyncExec set to true
   await new Promise((resolve, reject) => {
     const statement = connection.execute({
       sqlText: "CALL SYSTEM$WAIT(3, 'SECONDS')",
       asyncExec: true,
       complete: async function (err, stmt, rows) {
         queryId = statement.getQueryId();
         resolve();
       }
     });
   });
   
   // 2. Check query status until it's finished executing
   const seconds = 2;
   let status = await connection.getQueryStatus(queryId);
   while (connection.isStillRunning(status)) {
     console.log(`Query status is ${status}, timeout for ${seconds} seconds`);
   
     await new Promise((resolve) => {
       setTimeout(() => resolve(), 1000 * seconds);
     });
   
     status = await connection.getQueryStatus(queryId);
   }
   
   console.log(`Query has finished executing, status is ${status}`);
   

   Show lessSee more

   Scroll to top

SQL ステートメントのバッチの実行（複数ステートメントのサポート）¶

Node.jsコネクタのバージョン1.6.18以降では、セミコロンで区切られた SQL ステートメントのバッチを送信して、単一のリクエストで実行することができます。

クエリ文字列にセミコロンで区切られた複数のステートメントが含まれていることを除いて、複数のステートメントは、単一のステートメントでクエリを実行するのと同じ方法でバッチとして実行できます。複数のステートメントは、並列ではなく順に実行されることに注意してください。MULTI_STATEMENT_COUNT パラメーターは、バッチに含まれるステートメントの正確な数を指定します。

たとえば、 MULTI_STATEMENT_COUNT=3 を設定する場合は、バッチステートメントには正確に3つのステートメントを含める必要があります。それ以外の数のステートメントを含むバッチステートメントを送信すると、Node.jsドライバーはリクエストを拒否します。MULTI_STATEMENT_COUNT=0 を設定すると、バッチクエリに任意の数のステートメントを含めることができます。ただし、この値を使用すると、 SQL インジェクション攻撃に対する保護が低下することに注意してください。

このパラメーターは、次のコマンドを使用してセッションレベルで設定するか、クエリを送信するたびに個別に設定できます。

ALTER SESSION SET multi_statement_count = <n>

セッションレベルで値を設定すると、バッチステートメントを実行するたびに値を設定する必要がなくなります。次の例では、セッションレベルでステートメントの数を3に設定し、3つの SQL ステートメントを実行します。

CopyExpand

const statement = connection.execute({
  sqlText: 'ALTER SESSION SET multi_statement_count=0',
  complete: function (err, stmt, rows) {
    if (err) {
      console.error(`Failed to execute statement due to the following error: ${err.message}`);
    } else {
      testMulti();
    }
  }
});

function testMulti() {
  console.log('select bind execute.');
  const selectStatement = connection.execute({
    sqlText: 'create or replace table test(n int); insert into test values(1), (2); select * from test order by n',
    complete: function (err, stmt, rows) {
      if (err) {
        console.error(`Failed to execute statement due to the following error: ${err.message}`);
      } else {
        console.log('==== complete');
        console.log(`==== sqlText=${stmt.getSqlText()}`);
        if (stmt.hasNext()) {
          stmt.NextResult();
        } else {
          // do something else, for example close the connection
        }
      }
    }
  });
}

Show lessSee more

Scroll to top

connection.execute 関数のパラメーターとして MULTI_STATEMENT_COUNT を設定することにより、複数ステートメントのクエリを実行するたびに、バッチ内のステートメントの数を設定することもできます。次の例では、バッチのステートメント数を3に設定し、バッチクエリに3つの SQL ステートメントを含めます。

CopyExpand

// connection needs to be already set up
connection.connect((err, conn) => {
  if (err) {
    console.error(`Unable to connect: ${err.message}`);
  } else {
    console.log(`Successfully connected to Snowflake, connection id ${conn.getId()}`);
    testMulti();
  }
});

function testMulti() {
  console.log('execute multi-statement query');
  connection.execute({
    sqlText: 'create or replace table test(n int); insert into test values(1), (2); select * from test order by n',
    parameters: { MULTI_STATEMENT_COUNT: 3 },
    complete: function (err, stmt, rows) {
      if (err) {
        console.error(`Failed to execute statement: ${err.message}`);
      } else {
        console.log('==== complete');
        console.log(`==== sqlText=${stmt.getSqlText()}`);
        if (rows) {
          const stream = stmt.streamRows();
          console.log(`====QueryId=${stmt.getQueryId()}`);

          stream.on('data', row => {
            console.log(row);
          });
          stream.on('end', () => {
            console.log('done');
          });
        }

        if ('hasNext' in stmt && stmt.hasNext()) {
          stmt.NextResult();
        } else {
          connection.destroy(err1 => {
            if (err1) {
              console.error(`Unable to disconnect: ${err1.message}`);
            } else {
              console.log(`Disconnected connection with id: ${connection.getId()}`);
            }
          });
        }
      }
    }
  });
}

Show lessSee more

Scroll to top

ステートメントパラメーターのバインド¶

時には、ステートメント内のデータをプレースホルダーに バインド したいことがあります。この方法でステートメントを実行すると、 SQL インジェクション攻撃の防止に役立つため便利です。次のステートメントを考慮します。

CopyExpand

connection.execute({
  sqlText: 'SELECT c1 FROM (SELECT 1 AS c1 UNION ALL SELECT 2 AS c1) WHERE c1 = 1;'
});

Show lessSee more

Scroll to top

次のバインドを使用して同じ結果を達成できます。

CopyExpand

connection.execute({
  sqlText: 'SELECT c1 FROM (SELECT :1 AS c1 UNION ALL SELECT :2 AS c1) WHERE c1 = :1;',
  binds: [1, 2]
});

Show lessSee more

Scroll to top

バインドの ? 構文もサポートされています。

CopyExpand

connection.execute({
  sqlText: 'SELECT c1 FROM (SELECT ? AS c1 UNION ALL SELECT ? AS c1) WHERE c1 = ?;',
  binds: [1, 2, 1]
});

Show lessSee more

Scroll to top

一括挿入のための配列のバインド¶

データの配列のバインドは、一括 INSERT 操作でサポートされています。次のように配列の配列を渡します。

CopyExpand

connection.execute({
  sqlText: 'INSERT INTO t(c1, c2, c3) values(?, ?, ?)',
  binds: [[1, 'string1', 2.0], [2, 'string2', 4.0], [3, 'string3', 6.0]]
});

Show lessSee more

Scroll to top

VARIANT の配列データをバインドすることもできます。説明のために、次のように:codenowrap:VARIANT のデータを列として持つテーブルを作成したとします。

create or replace table test(id int, foo variant);

そして以下のスクリプトを実行します。

// standard stuff like defining connection, etc
const statement = connection.execute({
  // table columns are id: int, foo: variant
  sqlText: 'insert into test_db.public.test select value:id, value:foo from table(flatten(parse_json(?)))',
  binds: [JSON.stringify([
    { id: 1, foo: [{ a: '1', b: '2' }] },
    { id: 2, foo: [{ c: '3', d: '4' }] }
  ])],
  complete: function (err, stmt, rows) {
    if (err) {
      console.error(`Failed to execute statement due to the following error: ${err.message}`);
    } else {
      console.log(`[queryID ${statement.getStatementId()}, requestId ${statement.getRequestId()}] Number of rows produced: ${rows.length}`);
      // rest of the code
    }
  }
});

ステートメントのキャンセル¶

statement.cancel() メソッドを呼び出すと、ステートメントをキャンセルできます。

CopyExpand

statement.cancel((err, stmt) => {
  if (err) {
    console.error(`Unable to abort statement due to the following error: ${err.message}`);
  } else {
    console.log('Successfully aborted statement');
  }
});

Show lessSee more

Scroll to top

リクエストの再送信¶

ネットワークエラーまたはタイムアウトなどが原因で、Snowflakeが SQL ステートメントを正常に実行したかどうかが分からない場合は、リクエスト ID を使用して同じステートメントを再送信できます。たとえば、データを追加するために INSERT コマンドを送信したが、確認応答がタイムリーに受信されなかったため、コマンドで何が起こったのかが分からない場合があります。このシナリオでは、コマンドを2回実行してデータの重複が発生する可能性があるため、同じコマンドを新しいコマンドとして実行することは望ましくありません。

SQL ステートメントにリクエスト ID を含めると、データが重複する可能性を回避できます。最初のリクエストからのリクエスト ID を使用してリクエストを再送信すると、最初のリクエストが失敗した場合にのみ、再送信されたコマンドが実行されるようになります。詳細については、 SQL ステートメントの実行リクエストの再送信 をご参照ください。

次のコードサンプルは、リクエスト ID を保存して使用し、ステートメントを再送信する方法を示しています。ステートメントを実行すると、 getRequestId() 関数を使用して、送信されたリクエストの ID を取得できます。そうすると、その ID を使用して、後で同じステートメントを実行できます。次の例では、INSERT ステートメントを実行し、そのリクエスト ID を requestId 変数に保存します。

CopyExpand

let requestId;
connection.execute({
  sqlText: 'INSERT INTO testTable VALUES (1);',
  complete: function (err, stmt, rows) {
    const stream = stmt.streamRows();
    requestId = stmt.getRequestId(); // Retrieves the request ID
    stream.on('data', row => {
      console.log(row);
    });
    stream.on('end', () => {
      console.log('done');
    });
  }
});

Show lessSee more

Scroll to top

コマンドが正常に実行されたという確認を受信しない場合は、以下に示すように保存されたリクエスト ID を使用してリクエストを再送信できます。

CopyExpand

connection.execute({
  sqlText: 'INSERT INTO testTable VALUES (1);',  // optional
  requestId: requestId,  // Uses the request ID from before
  complete: function (err, stmt, rows) {
    const stream = stmt.streamRows();
    stream.on('data', row => {
      console.log(row);
    });
    stream.on('end', () => {
      console.log('done');
    });
  }
});

Show lessSee more

Scroll to top

requestId と sqlText を使用したリクエストの再送信を選択する場合は、次の相互作用に注意してください。

• requestId がすでに存在する場合、つまり以前のリクエストと一致する場合、コマンドは sqlText クエリを無視し、元のコマンドからクエリを再送信します。

• requestId が存在しない場合、つまり以前のリクエストと一致しない場合、コマンドは sqlText クエリを実行します。