предложение 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: STRING литерал обычно состоит из одного или нескольких строковых маркеров параметров и литеральных компонентов, которые объединяются;
• strExpr: константное 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 :re[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 :re[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 clause 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("myschema" -> "`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 :re[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 :re[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 :re[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
• Идентификаторы
• Маркеры параметров
• Имена