Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scroll ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-htmltrue
scroll-epubtrue

Open in new tab

About Collectors

Insert excerpt
Collector Method
Collector Method
nameabout

...

FIELD

FIELD TYPE

DESCRIPTION

EXAMPLE

client

string

Onboarded client in Azure to access Azure Synapse

 

secret

string

Onboarded client secret in Azure to access Azure Synapse

 

tenant

string

Tenant ID of where Azure Synapse exists

server

string

Azure Synapse server.

If using a custom port append with comma Example: “tcp:<workspace“<workspace-name>.sql.azuresynapse.net,1433”

“tcp:<workspace“<workspace-name>.sql.azuresynapse.net,1433”

host

string

The onboarded host value in K, generally this would be the same as the server value, depending on what you onboard it as.

“<workspace-name>.sql.azuresynapse.net,1433”

databases

list<string>

A list of databases to extract from SQLServer Azure

[“dwh”, “adw”]

driver

string

This is the ODBC driver, generally its ODBC Driver 17 for SQL Server, if you another driver installed please use that instead.

“ODBC Driver 17 for SQL Server”

meta_only

boolean

Do you want to extract metadata only without enabling extended events? We currently only support true

true

output_path

string

Absolute path to the output location where files are to be written

“/tmp/output”

mask

boolean

To enable masking or not

true

compress

boolean

To gzip the output or not

true

connection_timeout

integer

Timeout in seconds allowed against Synapse Sql Pool connection, this is defaulted as 30

30

...