Export-related Procedures

SYSADMIN.getAuthMechanism

This procedure returns the current authentication mechanism configured: LDAP or the default mechanism.

CODE

SYSADMIN.getAuthMechanism(OUT authMechanism string NOT NULL RESULT)

SYSADMIN.getCreateTempTablesPermissions

deprecated

SYSADMIN.getCreateTempTablesPermissions deprecated since v4.1

SYSADMIN.exportSQLConfiguration

This procedure allows to generate the export script.

SQL

CALL "SYSADMIN.exportSQLConfiguration"(
    "additionalExportInfo" => 'string_additionalExportInfo',
    "skipAggr" => boolean_skipAggr,
    "dsValidation" => boolean_dsValidation,
    "optValidation" => boolean_optValidation,
    "viewProcValidation" => boolean_viewProcValidation,
    "exportMatTableState" => boolean_exportMatTableState,
    "exportJobSpecificEmailNotifications" => boolean_exportJobSpecificEmailNotifications,
    "exportGlobalJobEmailNotifications" => boolean_exportGlobalJobEmailNotifications,
    "exportJobSpecificSlackNotifications" => boolean_exportJobSpecificSlackNotifications,
    "exportGlobalJobSlackNotifications" => boolean_exportGlobalJobSlackNotifications,
    "exportSmtpConfiguration" => boolean_exportSmtpConfiguration,
    "purgeSystemData" => boolean_purgeSystemData,
    "useMaintenanceMode" => boolean_useMaintenanceMode,
    "exportJbossSettings" => boolean_exportJbossSettings,
    "exportModularConnectors" => boolean_exportModularConnectors,
    "defaultOptions" => 'string_defaultOptions',
    "systemProperties" => 'string_systemProperties',
    "sshTunnelNames" => 'string_sshTunnelNames',
    "exportCorrespondingSshKeyPairs" => boolean_exportCorrespondingSshKeyPairs,
    "sshKeyPairIds" => 'string_sshKeyPairIds',
    "dataSources" => 'string_dataSources',
    "dataSourceFunctions" => 'string_dataSourceFunctions',
    "virtualSchemas" => 'string_virtualSchemas',
    "virtualViews" => 'string_virtualViews',
    "virtualProcedures" => 'string_virtualProcedures',
    "virtualFunctions" => 'string_virtualFunctions',
    "optimizationIds" => 'string_optimizationIds',
    "jobIds" => 'string_jobIds',
    "scheduleIds" => 'string_scheduleIds',
    "exportQueueHandlers" => boolean_exportQueueHandlers,
    "users" => 'string_users',
    "roles" => 'string_roles',
    "permissionIds" => 'string_permissionIds',
    "attributes" => 'string_attributes',
    "dataShops" => 'string_dataShops'
);;

This procedure takes the following parameters:

To view the full table, click the expand button in its top right corner

Parameter	In/Out	Type	Nullable?	Description	Default Value
`additionalExportInfo`	In	String	Yes	Additional information that will be added to the beginning of the export script
`skipAggr`	In	Boolean	Yes	Skips aggregation optimizations during export	`FALSE`
`dsValidation`	In	Boolean	Yes	Validates data sources on import	`FALSE`
`optValidation`	In	Boolean	Yes	Validates optimizations on import	`FALSE`
`viewProcValidation`	In	Boolean	Yes	Validates virtual views and procedures on import	`FALSE`
`exportMatTableState`	In	Boolean	Yes	Exports materialized table states. Please note that if you want to export the MatTable state, you have to set `optValidation` to `FALSE`	`TRUE`
`exportJobSpecificEmailNotifications`	In	Boolean	Yes	Exports job-specific email notifications	`TRUE`
`exportGlobalJobEmailNotifications`	In	Boolean	Yes	Exports global job email notifications	`TRUE`
`exportJobSpecificSlackNotifications`	In	Boolean	Yes	Exports job-specific Slack notifications	`TRUE`
`exportGlobalJobSlackNotifications`	In	Boolean	Yes	Exports global job Slack notifications	`TRUE`
`exportSmtpConfiguration`	In	Boolean	Yes	Exports SMTP configuration	`TRUE`
`purgeSystemData`	In	Boolean	Yes	Purges system data before export	`FALSE`
`useMaintenanceMode`	In	Boolean	Yes	Runs export in maintenance mode	`TRUE`
`exportJbossSettings`	In	Boolean	Yes	Exports JBoss settings	`FALSE`
`exportModularConnectors`	In	Boolean	Yes	Exports deployed modular connectors	`FALSE`
`defaultOptions`	In	String	Yes	Comma-separated default option names to export. If not set, all default options will be exported. Use empty string '' to exclude all default options
`systemProperties`	In	String	Yes	Comma-separated system properties to export. If not set, all system properties will be exported, use empty string '' to exclude all system properties
`sshTunnelNames`	In	String	Yes	Comma-separated SSH tunnel names to export. If not set, all SSH tunnels will be exported, use empty string '' to exclude all SSH tunnels
`exportCorrespondingSshKeyPairs`	In	Boolean	Yes	Exports corresponding SSH key pairs. If not set, all SSH key pairs will be exported, use empty string '' to exclude all SSH key pairs	`TRUE`
`sshKeyPairIds`	In	String	Yes	Comma-separated SSH key pair IDs to export. If not set, all SSH key pairs will be exported, use empty string '' to exclude all SSH key pairs
`dataSources`	In	String	Yes	Comma-separated data source names to export. If not set, all data sources will be exported, use empty string '' to exclude all data sources
`dataSourceFunctions`	In	String	Yes	Comma-separated data source functions to export. If not set, all data source functions will be exported, use empty string '' to exclude all data source functions
`virtualSchemas`	In	String	Yes	Comma-separated virtual schema names to export. If not set, all virtual schemas will be exported, use empty string '' to exclude all virtual schemas
`virtualViews`	In	String	Yes	Comma-separated virtual view full names to export. If not set, all virtual views will be exported, use empty string '' to exclude all virtual views
`virtualProcedures`	In	String	Yes	Comma-separated virtual procedure full names to export. If not set, all virtual procedures will be exported, use empty string '' to exclude all virtual procedures
`virtualFunctions`	In	String	Yes	Comma-separated virtual function full names to export. If not set, all virtual functions will be exported, use empty string '' to exclude all virtual functions
`optimizationIds`	In	String	Yes	Comma-separated optimization IDs to export. If not set, all optimizations will be exported. Use empty string '' to exclude all optimizations
`jobIds`	In	String	Yes	Comma-separated job IDs to export. If not set, all jobs will be exported. Use empty string '' to exclude all jobs
`scheduleIds`	In	String	Yes	Comma-separated schedule IDs to export. If not set, all schedules will be exported. Use empty string '' to exclude all schedules
`exportQueueHandlers`	In	Boolean	Yes	Exports queue handlers. If not set, all queue handlers will be exported. Use empty string '' to exclude all queue handlers	`TRUE`
`users`	In	String	Yes	Comma-separated users to export. If not set, all users will be exported. Use empty string '' to exclude all users
`roles`	In	String	Yes	Comma-separated roles to export. If not set, all roles will be exported. Use empty string '' to exclude all roles
`permissionIds`	In	String	Yes	Comma-separated permission IDs to export. If not set, all permissions will be exported. Use empty string '' to exclude all permissions
`attributes`	In	String	Yes	Comma-separated attributes in the format `<resourceName>:<attributeName>` to export. If not set, all attributes will be exported. Use empty string '' to exclude all attributes
`dataShops`	In	String	Yes	Comma-separated data shops to export. If not set, all data shops will be exported. Use empty string '' to exclude all data shops
`position`	Out	Integer	No	Position of the script part in the overal export script
`type`	Out	String	No	Type of exported objects
`script`	Out	String	No	Export script

SYSADMIN.exportSQLConfiguration available since v25.3