Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Multiexcerpt macro
nameGetting Encrypted Data from the Database

Getting Encrypted Data from the Database

  • To get the values of the query result as plain text in the output, enter the following URL properties (Url property name and Url property value) in the SQL Server account that the Snap uses.

      columnEncryptionSetting: Enabled

  • If you have encryption columns that are created using java keystore, enter the following additional URL properties along with columnEncryptionSetting.

      keyStoreLocation: /path/to/jksfile

   keyStoreSecret: <password_used_to_create_jks>

   keyStoreAuthentication: JavaKeyStorePassword (fixed value)

Snap Type

SQL Server - Select Snap is a Read-type Snap that executes SQL SELECT statement.

...

Field Name

Field Type

Description

Label*

Default ValueSQL Server - Select
Example: SQL Server - Select

String

Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Schema Name

Default Value: N/A
Example: schema_demo

String/Expression/Suggestion

Specify the database schema name. In case it is not defined, then the suggestion for the Table Name retrieves all tables names of all schemas. The property is suggestible and will retrieve available database schemas during suggest values..

Table Name*

Default Value: N/A
Example: employees_table

String/Expression/Suggestion

Specify the table to execute the select query on.

Where Clause 

Default Value: N/A
Example: SELECT * FROM employees WHERE salary > 50000

String/Expression/Suggestion

Specify the WHERE clause of the SELECT statement. This supports document value substitution (such as $person.firstname is substituted with the value found in the incoming document at the path). However, you cannot use a value substitution after "IS" or "is" word.

Examples:

Without using expressions

  • EmpId = 12 

  • email = 'you@example.com'

Using expressions

  • "EMPNO=$EMPNO and ENAME=$EMPNAME"

  • email = $email 

  • emp=$emp

  • "emp='" + $emp + "'"

  • "EMPNO=" + $EMPNO + " and ENAME='" + $EMPNAME+ "'"

Note

Using expressions that join strings together to create SQL queries or conditions has a potential SQL injection risk and is hence unsafe. Ensure that you understand all implications and risks involved before using concatenation of strings with '=' Expression enabled. 

Order By 

Use this fieldset to specify the columns in the order in which you want to sort the database. The default database sort order will be used.

Column Names

 

Default Value: N/A
Example: name

String/Expression

Specify the column names.

Limit Offset

Default Value: N/A
Example: 0

Integer/Expression

Specify the offset for the limit clause. This is where the result set should start. Starting row for the query.

Some databases do not support OFFSET, such as Teradata, and the Limit offset field is ignored.

Limit Rows 

Default Value: N/A
Example: 10

Integer/Expression

Specify the number of rows to return from the query.

Query Hints

Default Value: N/A
Example: OPTION (USE HINT ('DISABLE_OPTIMIZER_ROWGOAL'))

String/Expression

Specify the hints to customize and optimize the database engine in processing the query statement.

Query hints that are supported are dependent on the SQL database version. For instance, SELECT * from sys.dm_exec_valid_use_hints query helps you list out the hints that are supported by a specific database.

Output fields

Use this fieldset to specify the output fields for SQL SELECT statement.

Output Field

Default Value: N/A
Example: email, address, first, last

String/Expression

Specify or select output field names for SQL SELECT statement. To select all fields, leave it at default.

Fetch Output Fields In Schema

Default Value: Deselected

Checkbox

Select this check box to include only the selected fields or columns in the Output Schema (second output view). If you do not provide any Output fields, all the columns are visible in the output.
If you provide output fields, we recommend you to select Fetch Output Fields In Schema checkbox.

Pass-through 

Default Value: Selected

Checkbox

Select this checkbox to pass the input document through the output view under the key 'original'. 

Ignore empty result

Default Value: Deselected

Checkbox

Select this checkbox if you do not want to write to the output view when a SELECT operation does not produce any result or is empty.
If you do not select this property and select the Pass through checkbox, the input document is passed through to the output view.

Auto Commit

Default Value: False
Example: True

Dropdown list

Select one of the options for this property to override the state of the Auto commit property on the account. The Auto commit at the Snap-level has three values: TrueFalse, and Use account setting. The expected functionality for these modes are:

  •  True - The Snap will execute with auto-commit enabled regardless of the value set for Auto commit in the Account used by the Snap.

  •  False - The Snap will execute with auto-commit disabled regardless of the value set for Auto commit in the Account used by the Snap.

  • Use account setting - The Snap will execute with Auto commit property value inherited by the Account used by the Snap.

Match data types

Default Value: Deselected

Checkbox

This property applies only when the Output fields property is provided with any field value(s).

If this property is selected, the Snap tries to match the output data types same as when the Output fields property is empty (SELECT * FROM ...). The output preview would be in the same format as the one when SELECT * FROM is implied and all the contents of the table are displayed.

Number of Retries

Default Value: 0
Example: 3

Integer/Expression

Specify the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response.

Info
  • If the value is larger than 0, the Snap first downloads the target file into a temporary local file. If any error occurs during the download, the Snap waits for the time specified in the Retry interval and attempts to download the file again from the beginning. When the download is successful, the Snap streams the data from the temporary file to the downstream Pipeline. All temporary local files are deleted when they are no longer needed.

  • Ensure that the local drive has sufficient free disk space to store the temporary local file.

Retry Interval (seconds)

Default Value: 1
Example:  10

Integer/Expression

Specify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception.

Staging mode

Default Value: In memory
Example: On disk

Dropdown list

Required when the value in the Number of retries field is greater than 0. 

Specify the location from the following options to store input documents between retries:

  • In memory: The query results are stored in the Snaplex memory. If the query is too large to fit in the memory space, it may cause the Snap to fail, choose the On disk option.

  • On disk: The query results are stored on the disk in a temporary (tmp) directory that is managed by the SnapLogic platform. This directory is deleted automatically when the Snap terminates.

Option for Unique Identifier Column

Default Value: Convert to lower case
Example: Convert to upper case

Dropdown list

This propery applies only when the Snap returns the unique identifier (GUID) in the output.

Specify the unique identifier is stored in the database using an internal format and when it is displayed in the output, it is converted to a string and gets displayed in upper case for HEX characters. Select either of the following options to change the case type. Available options are:

  • Convert to lower case: Modifies the output string to lower case.

  • Convert to upper case: Modifies the output string to upper case.

Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read

Default Value: Validate & Execute
Example: Execute only

Dropdown list

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

Examples

Fetch employee details from a table in the SQL Server database

This example pipeline demonstrates how to retrieve employee details from the Employee_Demo table.

...

Configure the Mapper Snap with the Employee name and map it to the target column Emp_Name.

...

Expand

Insert excerpt
SQL Server Snap Pack
SQL Server Snap Pack
nameSQL_Server_SPH
nopaneltrue

...

Related Content