IDENTIFIER 句

適用対象: Databricks SQL Databricks Runtime 13.3 LTS 以降

IDENTIFIER句を使用すると、SQL ステートメントでの識別子の SQL インジェクション セーフなパラメーター化が可能になります。

• 適用対象:Databricks Runtime 18.0 以上で

  引数が文字列リテラルまたは文字列パラメーター マーカーのみで構成されている限り、マルチパート名内の任意のオブジェクト名または識別子の代わりに句を使用できます。 これには、 'myschema' :table 'mycolumn' や :schema :table :columnなどの結合文字列が含まれます。

• 適用対象: Databricks SQL Databricks Runtime 13.3 LTS 以降

  IDENTIFIER句は、'myschema' || :table || 'mycolumn'や:schema || :table || :columnなどの定数文字列を次のように解釈します。

  • リレーション (テーブルまたはビュー) 名
  • 関数名
  • 列名
  • フィールド名
  • スキーマ名
  • カタログ名

  IDENTIFIER句は、次のステートメントに制限されます。

  • CREATE、ALTER、DROP、または UNDROP ステートメントのテーブル、ビュー、または関数のサブジェクト名。
  • MERGE、 UPDATE、DELETE、 INSERT、 COPY INTO ステートメントのターゲット テーブル名。
  • SHOW ステートメントまたは DESCRIBE ステートメントのターゲット。
  • スキーマまたはカタログの使用
  • 関数の呼び出し
  • クエリで参照される列、テーブル、またはビュー。 これには、DDL または DML ステートメントに埋め込まれたクエリが含まれます。

構文

IDENTIFIER ( strLiteral )

IDENTIFIER ( strExpr )

パラメーター

• strLiteral: 通常、1 つ以上の文字列STRINGと合体されるリテラル コンポーネントで構成される リテラル。
• strExpr: 通常 1 つ以上のSTRINGを含む、定数 式。 Databricks Runtime 18.0 以降では、この表記は非推奨です。

例

Scala

// Creation of a table using parameter marker.
spark.sql("CREATE TABLE IDENTIFIER(:mytab)(c1 INT)", args = Map("mytab" -> "tab1"))

// Altering a table with a fixed schema and a parameterized table name.
spark.sql("ALTER TABLE IDENTIFIER('default.' || :mytab) ADD COLUMN c2 INT)", args = Map("mytab" -> "tab1"))

// Altering a table with a fixed schema and a parameterized table name in DBR 18.0 and above.
spark.sql("ALTER TABLE IDENTIFIER('default.' :mytab) ADD COLUMN c2 INT)", args = Map("mytab" -> "tab1"))

// Dropping a table with separate schema and table parameters.
spark.sql("DROP TABLE IDENTIFIER(:myschema || '.' || :mytab)", args = Map("mySchema" -> "default", "mytab" -> "tab1"))

// Dropping a table with separate schema and table parameters in DBR 18.0 and above.
spark.sql("DROP TABLE IDENTIFIER(:myschema '.' :mytab)", args = Map("mySchema" -> "default", "mytab" -> "tab1"))

// A parameterized reference to a table in a query. The table name is qualified and uses back-ticks.
spark.sql("SELECT * FROM IDENTIFIER(:mytab)", args = Map("mytab" -> "`default`.`tab1`"))

// You cannot qualify the IDENTIFIER claue or use it as a qualifier itself.
spark.sql("SELECT * FROM myschema.IDENTIFIER(:mytab)", args = Map("mytab" -> "`tab1`"))

spark.sql("SELECT * FROM IDENTIFIER(:myschema).mytab", args = Map("mychema" -> "`default`"))

// A parameterized column reference
spark.sql("SELECT IDENTIFIER(:col) FROM VALUES(1) AS T(c1)", args = Map("col" -> "t.c1"))

// Passing in an aggregate function name as a parameter
spark.sql("SELECT IDENTIFIER(:agg)(c1) FROM VALUES(1), (2) AS T(c1)", args = Map("agg" -> "max"))

SQL

-- Using a catalog using a variable.
> DECLARE mycat = 'main';
> USE CATALOG IDENTIFIER(mycat);

-- Creation of a table using variable.
> DECLARE mytab = 'tab1';
> CREATE TABLE IDENTIFIER(mytab)(c1 INT);

-- Altering a table with a fixed schema and a parameterized table name.
> ALTER TABLE IDENTIFIER('default.' || mytab) ADD COLUMN c2 INT;

-- Altering a table with a fixed schema and a parameterized table name in DBR 18.0 and above.
> ALTER TABLE IDENTIFIER('default.' || mytab) ADD COLUMN c2 INT;

-- Inserting using a parameterized table name. The table name is qualified and uses back-ticks.
> SET VAR mytab = '`default`.`tab1`';
> INSERT INTO IDENTIFIER(mytab) VALUES(1, 2);

-- A parameterized reference to a table in a query.
> SELECT * FROM IDENTIFIER(mytab);
  1   2

-- Dropping a table with separate schema and table parameters.
> DECLARE myschema = 'default';
> SET VAR mytab = 'tab1';
> DROP TABLE IDENTIFIER(myschema || '.' || mytab);
-- In DBR 18.0 and above:
> DROP TABLE IDENTIFIER(myschema '.' mytab);

-- You cannot qualify the IDENTIFIER clause or use it as a qualifier itself prior to DBR 18.0.
> SELECT * FROM myschema.IDENTIFIER('tab');
Error: PARSE_SYNTAX_ERROR

> SELECT * FROM IDENTIFIER('default').mytab;
Error: PARSE_SYNTAX_ERROR

-- A parameterized column reference
> DECLARE col = 't.c1';
> SELECT IDENTIFIER(col) FROM VALUES(1) AS T(c1);
  1

-- Passing in an aggregate function name as a parameter
> DECLARE agg = 'max';
> SELECT IDENTIFIER(agg)(c1) FROM VALUES(1), (2) AS T(c1);
  2

関連項目

• EXECUTE IMMEDIATE
• 識別子
• パラメーター マーカー
• [名前]