PutDatabricksSQL
Description
Submit a SQL Execution using Databricks REST API then write the JSON response to FlowFile Content. For high performance SELECT or INSERT queries use ExecuteSQL instead.
Tags
databricks, sql
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Databricks Client * | Databricks Client | Controller Service: DatabricksWorkspaceClientService Implementations: StandardDatabricksWorkspaceClientService | Databricks Client Service. | |
| Statement * | Statement | SQL statement to execute Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Default Catalog | Default Catalog | Default table catalog, some SQL statements such as 'COPY INTO' do not support using a default catalog Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Default Schema | Default Schema | Default table schema, some SQL statements such as 'COPY INTO' do not support using a default schema Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| SQL Warehouse ID | SQL Warehouse ID | Warehouse ID used to execute SQL | ||
| SQL Warehouse Name | SQL Warehouse Name | SQL Warehouse Name used to execute SQL, will search through all SQL Warehouses to find matching name. | ||
| Record Writer | Record Writer | Controller Service: RecordSetWriterFactory Implementations: AvroRecordSetWriter CSVRecordSetWriter FreeFormTextRecordSetWriter JsonRecordSetWriter RecordSetWriterLookup ScriptedRecordSetWriter XMLRecordSetWriter | Specifies the Controller Service to use for writing results to a FlowFile. The Record Writer may use Inherit Schema to emulate the inferred schema behavior, i.e. an explicit schema need not be defined in the writer, and will be supplied by the same logic used to infer the schema from the column types. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | Databricks failure relationship |
| http.response | HTTP Response to SQL API Request |
| original | The original FlowFile is routed to this relationship when processing is successful. |
| records | Serialized SQL Records |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| error.code | The error code for the SQL statement if an error occurred. |
| error.message | The error message for the SQL statement if an error occurred. |
| statement.state | The final state of the executed SQL statement |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
Input requirements are not specified for this component.
System Resource Considerations
This component does not specify system resource considerations.