ApsaraDB RDS:SQL スロットリング (rds_ccl)

シナリオ

この関数は、プライマリインスタンスでのみ呼び出して SQL スロットリングルールを作成できます。

構文

• 構文 1: 特定の SQL 文に対してスロットリングを実行します。

  SELECT rds_add_ccl_rule(
  	query_string varchar,
  	node_tag int,
  	max_concurrency int,
  	max_waiting int,
  	is_enabled boolean,
  	comment varchar,		-- オプション
  	search_path varchar		-- オプション
  );

• 構文 2: 特定の query_id に基づいてスロットリングを実行します。

  SELECT rds_add_ccl_rule_with_query_id(
    query_id		bigint,
    node_tag		int,
    max_concurrency	int,
    max_waiting		int,
    is_enabled		boolean,
    query_string		varchar,	-- オプション
    comment		varchar,	-- オプション
    search_path           varchar		-- オプション (バージョン 1.2 以後でサポート)
  );

パラメータ

-- $$ を使用して SQL 文を囲みます。
$$SELECT * FROM my_table;$$

-- SQL 文に既に $$ が含まれている場合は、$ccl$ を使用して SQL 文を囲みます。
$ccl$SELECT * FROM my_table WHERE my_column = $$hello$$;$ccl$

使用上の注意

• 構文 1 では、comment パラメータと search_path パラメータを設定しない場合は、空の文字列 ('') に設定できます。 NULL に設定すると、関数は何も実行せずにすぐに返されます。

• 構文 2 では:

  • query_string パラメータと comment パラメータを設定しない場合は、空の文字列 ('') に設定できます。 NULL に設定すると、関数は何も実行せずにすぐに返されます。

  • query_id と query_string の両方を設定すると、AliPG カーネルは query_id に基づいて SQL 速度制限を実行します。

• この関数は ccl_id を返します。これは、現在のデータベースにおける速度制限ルールの固有識別子です。

SQL の例

プライマリインスタンスの `ccl_test` データベースに `ccl_tbl` という名前のデータテーブルが存在するとします。次の要件を満たす SQL スロットリングルールを作成します。

1. すべての SELECT * FROM ccl_tbl 文をスロットリングします。それらの query_id は `1` であるとします。

2. このような SQL 文の同時実行は最大 3 つまで許可します。

3. このような SQL 文の最大 2 つを待機できるようにします。

4. ルールは作成後すぐに有効にする必要があります。

• 構文 1:

  SELECT rds_add_ccl_rule(
    $$SELECT * FROM ccl_tbl;$$,		-- 速度制限の対象となる SQL 文。$$ で囲みます。
    1,					-- プライマリインスタンスのみを速度制限します。
    3,					-- このような SQL 文の最大 3 つを同時に実行できるようにします。
    2,					-- このような SQL 文の最大 2 つを待機できるようにします。
    true,					-- ルールはすぐに有効になります。
    'limit constant select',		-- ルールの説明。
    ''					-- デフォルトの search_path を使用します。
  );

• 構文 2:

  SELECT rds_add_ccl_rule_with_query_id(
    1,					-- 速度制限の対象となる SQL 文の query_id。
    1,					-- プライマリインスタンスのみを速度制限します。
    3,					-- このような SQL 文の最大 3 つを同時に実行できるようにします。
    2,					-- このような SQL 文の最大 2 つを待機できるようにします。
    true,					-- ルールはすぐに有効になります。
    '',					-- SQL 文のテキスト。この例では指定されていません。
    'limit constant select',		-- ルールの説明。
    'public'                              -- search_path。
  );

シナリオ

このコマンドは、プライマリインスタンスまたは読み取り専用インスタンスで実行して、作成された SQL スロットリングルールをクエリできます。

構文

• 現在のインスタンスのすべてのデータベースにあるすべての SQL スロットリングルールを表示するには:

  SELECT * FROM rds_enabled_ccl_rule;

  説明

  • このコマンドのクエリ結果では、表示上の制限により、query_string と comment の値は 200 文字に切り捨てられます。完全な情報を表示するには、SELECT * FROM rds_show_current_db_ccl_rule(); コマンドを実行します。

  • rds_ccl のバージョン 1.2 以降では、search_path の返却をサポートしています。

• 現在のデータベースのすべての SQL スロットリングルールをクエリするには:

  SELECT * FROM rds_show_current_db_ccl_rule();

シナリオ

この関数はプライマリインスタンスでのみ呼び出すことができます。この関数は、次のシナリオに適用されます。

• SQL スロットリングルールを作成するときに is_enabled パラメーターを false に設定した場合、この関数を使用してルールを有効にできます。

• この関数を使用して、以前に無効にされたルールを有効にすることもできます。

構文

SELECT rds_enable_ccl_rule(ccl_id int);

パラメータ

使用上の注意

なし。

SQL の例

SELECT rds_enable_ccl_rule(1);

シナリオ

この関数は、プライマリインスタンスまたは読み取り専用インスタンスで呼び出して SQL スロットリングルールをロードできます。ロードされたルールのみが SQL スロットリングに使用できます。

この関数は、次のシナリオに適用されます。

• プライマリインスタンス:

  • SQL スロットリングルールを作成するときに、is_enabled が true に設定されている場合、ルールはプライマリインスタンスに自動的にロードされます。この場合、この関数を呼び出す必要はありません。

  • SQL スロットリングルールを作成するときに、is_enabled が false に設定されている場合、rds_enable_ccl_rule 関数を呼び出して有効にすると、ルールはプライマリインスタンスに自動的にロードされます。この場合、この関数を呼び出す必要はありません。

  • プライマリインスタンスが再起動された場合は、この関数を手動で呼び出してルールをロードする必要があります。

• 読み取り専用インスタンス:

  ルールを読み取り専用インスタンスで有効にする必要がある場合は、プライマリインスタンスでルールを作成し、node_tag パラメーターを 2 または 3 に設定する必要があります。次に、読み取り専用インスタンスでこの関数を呼び出して、ルールを手動でロードする必要があります。

構文

SELECT rds_load_ccl_rule(ccl_id int);

パラメータ

使用上の注意

• 読み取り専用インスタンスにルールをロードできるのは、rds_add_ccl_rule 関数を呼び出してプライマリインスタンスに SQL スロットリングルールを作成し、node_tag パラメーターを 2 または 3 に設定した後のみです。

• 無効化されたルールはロードできません。無効化されたルールを読み取り専用インスタンスにロードするには、まずプライマリインスタンスでルールを有効にする必要があります。詳細については、「SQL スロットリングルールを有効にする」をご参照ください。

SQL の例

SELECT rds_load_ccl_rule(1);

シナリオ

この関数は、プライマリインスタンスでのみ呼び出して、SQL スロットリングルールの最大同時実行数と最大待機数を変更できます。

構文

SELECT rds_update_ccl_rule(
	ccl_id int,
	new_max_concurrency int,
	new_max_waiting int
);

パラメータ

使用上の注意

• SQL スロットリングルールへの更新はすぐに有効になります。

• SQL スロットリングルールでは、最大同時実行数と最大待機数のみを変更できます。

SQL の例

SELECT rds_update_ccl_rule(
 2,     -- ccl_id
 4,     -- 新しい最大同時実行数は 4 です。
 5      -- 新しい最大待機数は 5 です。
);

シナリオ

この関数は、プライマリインスタンスでのみ呼び出して SQL スロットリングルールを無効にできます。ルールが無効になると、SQL 文はスロットリングされなくなります。

構文

• 特定の SQL スロットリングルールを無効にするには:

  SELECT rds_disable_ccl_rule(ccl_id int);

• 現在のデータベースのすべての SQL スロットリングルールを無効にするには:

  SELECT rds_disable_all();

パラメータ

使用上の注意

• 無効化されたルールはロードできません。無効化されたルールを読み取り専用インスタンスにロードするには、まずプライマリインスタンスでルールを有効にする必要があります。詳細については、「SQL スロットリングルールを有効にする」をご参照ください。

• SQL スロットリングルールを無効にすると、ルールはプライマリインスタンスから自動的にアンロードされ、SQL 文はスロットリングされなくなります。

SQL の例

SELECT rds_disable_ccl_rule(1);

シナリオ

この関数は、プライマリインスタンスまたは読み取り専用インスタンスで呼び出して SQL スロットリングルールをアンロードできます。アンロードされたルールは、SQL 文をスロットリングしなくなります。

この関数は、次のシナリオに適用されます。

• プライマリインスタンス:

  • プライマリインスタンスで rds_disable_ccl_rule または rds_disable_all 関数を呼び出してルールを無効にすると、ルールはプライマリインスタンスから自動的にアンロードされます。この場合、この関数を呼び出す必要はありません。

  • プライマリインスタンスで rds_del_ccl_rule 関数を呼び出してルールを削除すると、ルールはプライマリインスタンスから自動的にアンロードされます。この場合、この関数を呼び出す必要はありません。

  • この関数を呼び出して、プライマリインスタンスからルールを手動でアンロードすることもできます。

• 読み取り専用インスタンス:

  ルールが読み取り専用インスタンスで SQL 文をスロットリングしないようにする場合は、この関数を呼び出して読み取り専用インスタンスから手動でアンロードできます。

構文

SELECT rds_unload_ccl_rule(ccl_id int, db_name varchar default '');

パラメータ

使用上の注意

ルールがアンロードされると、SQL 文はスロットリングされなくなります。ルールを再度使用するには、リロードする必要があります。詳細については、「SQL スロットリングルールをロードする」をご参照ください。

SQL の例

SELECT rds_unload_ccl_rule(1,'');

シナリオ

この関数は、プライマリインスタンスでのみ呼び出して、SQL 速度制限ルールを削除できます。 ルールが削除されると、プライマリインスタンスから自動的にアンロードされます。

構文

SELECT rds_del_ccl_rule(ccl_id int);

パラメータ

使用上の注意

なし。

SQL の例

SELECT rds_del_ccl_rule(1);

結果の例:

   rds_del_ccl_rule   
----------------------
 -7851264404688445170
(1 row)

• query_id は、PostgreSQL の SQL 文の特別な識別子です。類似の SQL 文は同じ query_id を共有します。

  例:

  -- 次の 2 つの SQL 文は同じ query_id を持ちます。
  SELECT * FROM tbl WHERE a = 1;
  SELECT * FROM tbl WHERE a = 2;

• query_id には、オブジェクト識別子 (oid) に基づく SQL 文内のオブジェクトに関する情報が含まれています。同じ名前のテーブルでも、異なるデータベースまたはスキーマにある場合は、異なるオブジェクトと見なされます。したがって、同一の SQL 文でも、参照するオブジェクトが異なれば query_id の値は異なります。

• SQL 文でアクセスされるオブジェクトがグローバルテーブルまたはグローバル関数の場合、文が実行されるデータベースに関係なく query_id は同じになります。

  • 例 1: pg_database はグローバルテーブルです。このテーブルを異なるデータベースからクエリした場合、query_id は同じになります。

    • `ccl_test` データベースで次の文を実行します。

      SELECT rds_get_query_id($$SELECT * FROM pg_database;$$);

      結果の例:

         rds_get_query_id   
      ----------------------
       -8733244708994363681
      (1 row)

    • `ccl_test2` データベースで次の文を実行します。

      SELECT rds_get_query_id($$SELECT * FROM pg_database;$$);

      結果の例:

         rds_get_query_id   
      ----------------------
       -8733244708994363681
      (1 row)

  • 例 2: pg_sleep はグローバル関数です。この関数を異なるデータベースから呼び出した場合、query_id は同じになります。

    • `ccl_test` データベースで次の文を実行します。

      SELECT rds_get_query_id($$SELECT pg_sleep(1);$$);

      結果の例:

        rds_get_query_id  
      --------------------
       440101247839410938
      (1 row)

    • `ccl_test2` データベースで次の文を実行します。

      SELECT rds_get_query_id($$SELECT pg_sleep(1);$$);

      結果の例:

        rds_get_query_id  
      --------------------
       440101247839410938
      (1 row)

• 関数を呼び出す場合、パラメータタイプが変更された場合、または FROM 句が追加または削除された場合、query_id は変更されます。

  たとえば、pg_sleep 関数を呼び出すと、返される query_id はコンテキストによって異なります。

  • `FROM` 句なし:

    SELECT rds_get_query_id($$SELECT pg_sleep(1);$$);

    結果の例:

      rds_get_query_id  
    --------------------
     440101247839410938
    (1 row)

  • `FROM` 句あり:

    SELECT rds_get_query_id($$SELECT * FROM pg_sleep(1);$$);

    結果の例:

       rds_get_query_id   
    ----------------------
     -3404018605099167039
    (1 row)

  • パラメーターの型が変更された場合:

    select rds_get_query_id($$SELECT * FROM pg_sleep(1.0);$$);

    結果の例:

      rds_get_query_id   
    ---------------------
     3073869725037049158
    (1 row)