Skip to content

Commit 57fb2aa

Browse files
v-stsavellv-stsavell
authored
Merge pull request #24390 from dzsquared/sqlpackage-192
update properties docs for 19.2
2 parents 9d8e1c0 + c2fd3db commit 57fb2aa

4 files changed

Lines changed: 87 additions & 86 deletions

File tree

‎docs/tools/sqlpackage/sqlpackage-export.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 198198e2-7cf4-4a21-bda4-51b36cb4284b
99
author: "dzsquared"
1010
ms.author: "drskwier"
1111
ms.reviewer: "maghan"
12-
ms.date: 7/29/2022
12+
ms.date: 9/29/2022
1313
---
1414

1515
# SqlPackage Export parameters and properties
@@ -93,15 +93,15 @@ sqlpackage.exe /at:$($AccessToken_Object.Token) /Action:Export /TargetFile:"C:\A
9393
|**/p:**|CommandTimeout=(INT32 '60')|Specifies the command timeout in seconds when executing queries against SQL Server.|
9494
|**/p:**|CompressionOption=({Normal|Maximum|Fast|SuperFast|NotCompressed} 'Normal')|Specifies the type of compression.|
9595
|**/p:**|DatabaseLockTimeout=(INT32 '60')| Specifies the database lock timeout in seconds when executing queries against SQLServer. Use -1 to wait indefinitely.|
96-
|**/p:**|HashObjectNamesInLogs=(BOOLEAN)|Specifies whether to replace all object names in logs with a random hash value.|
97-
|**/p:**|IgnoreIndexesStatisticsOnEnclaveEnabledColumns=(BOOLEAN)|Specifies whether indexes or statistics on columns encrypted using randomized encryption and enclave-enabled column encryption keys should be ignored (not included in the generated bacpac). By default (false) any index or a statistic on a column encrypted using randomized encryption and an enclave-enabled column encryption key will block the export action.|
98-
|**/p:**|LongRunningCommandTimeout=(INT32 '0')| Specifies the long running command timeout in seconds when executing queries against SQL Server. Use 0 to wait indefinitely.|
99-
|**/p:**|Storage=({File|Memory} )| Specifies the type of backing storage for the schema model used during extraction. 'Memory' is default for .NET Core version of SqlPackage. 'File' is only available and default for .NET Framework version of SqlPackage. |
96+
|**/p:**|HashObjectNamesInLogs=(BOOLEAN 'False')|Specifies whether to replace all object names in logs with a random hash value.|
97+
|**/p:**|IgnoreIndexesStatisticsOnEnclaveEnabledColumns=(BOOLEAN 'False')|Specifies whether indexes or statistics on columns encrypted using randomized encryption and enclave-enabled column encryption keys should be ignored (not included in the generated bacpac). By default (false) any index or a statistic on a column encrypted using randomized encryption and an enclave-enabled column encryption key will block the export action.|
98+
|**/p:**|LongRunningCommandTimeout=(INT32 '0')|Specifies the long running command timeout in seconds when executing queries against SQL Server. Use 0 to wait indefinitely.|
99+
|**/p:**|Storage=({File|Memory})|Specifies the type of backing storage for the schema model used during extraction. 'Memory' is default for .NET Core version of SqlPackage. 'File' is only available and default for .NET Framework version of SqlPackage. |
100100
|**/p:**|TableData=(STRING[])|Indicates the table from which data will be extracted. Specify the table name with or without the brackets surrounding the name parts in the following format: schema_name.table_identifier. This option may be specified multiple times.|
101101
|**/p:**|TargetEngineVersion=({Default|Latest|V11|V12} 'Latest')|This property is deprecated and use is not recommended. Specifies the version the target engine for Azure SQL Database is expected to be.|
102102
|**/p:**|TempDirectoryForTableData=(STRING)|Specifies an alternative temporary directory used to buffer table data before being written to the package file. The space required in this location may be large and is relative to the full size of the database.|
103103
|**/p:**|VerifyExtraction=(BOOLEAN 'True')|Specifies whether the extracted schema model should be verified. If set to true, schema validation rules are run on the dacpac or bacpac.|
104-
|**/p:**|VerifyFullTextDocumentTypesSupported=(BOOLEAN)|Specifies whether the supported full-text document types for Microsoft Azure SQL Database v12 should be verified.|
104+
|**/p:**|VerifyFullTextDocumentTypesSupported=(BOOLEAN 'False')|Specifies whether the supported full-text document types for Microsoft Azure SQL Database v12 should be verified.|
105105

106106
## Next Steps
107107

‎docs/tools/sqlpackage/sqlpackage-extract.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 198198e2-7cf4-4a21-bda4-51b36cb4284b
99
author: "dzsquared"
1010
ms.author: "drskwier"
1111
ms.reviewer: "maghan"
12-
ms.date: 7/29/2022
12+
ms.date: 9/29/2022
1313
---
1414

1515
# SqlPackage Extract parameters and properties
@@ -100,9 +100,9 @@ sqlpackage.exe /at:$($AccessToken_Object.Token) /Action:Extract /TargetFile:"C:\
100100

101101
|Property|Value|Description|
102102
|---|---|---|
103-
|**/p:**|AzureStorageBlobEndpoint=(STRING)|Azure blob storage endpoint, see [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#extract).|
104-
|**/p:**|AzureStorageContainer=(STRING)|Azure blob storage container, see [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#extract).|
105-
|**/p:**|AzureStorageKey=(STRING)|Azure storage account key, see [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#extract).|
103+
|**/p:**|AzureStorageBlobEndpoint=(STRING)|Azure blob storage endpoint. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#extract).|
104+
|**/p:**|AzureStorageContainer=(STRING)|Azure blob storage container. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#extract).|
105+
|**/p:**|AzureStorageKey=(STRING)|Azure storage account key. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#extract).|
106106
|**/p:**|AzureStorageRootPath=(STRING)|Storage root path within the container. Without this property, the path defaults to `servername/databasename/timestamp/`. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#extract).|
107107
|**/p:**|CommandTimeout=(INT32 '60')|Specifies the command timeout in seconds when executing queries against SQL Server.|
108108
|**/p:**|CompressionOption=({Normal|Maximum|Fast|SuperFast|NotCompressed} 'Normal')|Specifies the type of compression.|
@@ -111,15 +111,15 @@ sqlpackage.exe /at:$($AccessToken_Object.Token) /Action:Extract /TargetFile:"C:\
111111
|**/p:**|DacMajorVersion=(INT32 '1')|Defines the major version to be stored in the DACPAC metadata.|
112112
|**/p:**|DacMinorVersion=(INT32 '0')|Defines the minor version to be stored in the DACPAC metadata.|
113113
|**/p:**|DatabaseLockTimeout=(INT32 '60')|Specifies the database lock timeout in seconds when executing queries against SQLServer. Use -1 to wait indefinitely.|
114-
|**/p:**|ExtractAllTableData=(BOOLEAN)|Indicates whether data from all user tables is extracted. If 'true', data from all user tables is extracted, and you cannot specify individual user tables for extracting data. If 'false', specify one or more user tables to extract data from.|
114+
|**/p:**|ExtractAllTableData=(BOOLEAN 'False')|Indicates whether data from all user tables is extracted. If 'true', data from all user tables is extracted, and you cannot specify individual user tables for extracting data. If 'false', specify one or more user tables to extract data from.|
115115
|**/p:**|ExtractApplicationScopedObjectsOnly=(BOOLEAN 'True')|If true, only extract application-scoped objects for the specified source. If false, extract all objects for the specified source.|
116116
|**/p:**|ExtractReferencedServerScopedElements=(BOOLEAN 'True')|If true, extract login, server audit, and credential objects referenced by source database objects.|
117117
|**/p:**|ExtractTarget=({DacPac|File|Flat|ObjectType|Schema|SchemaObjectType} 'DacPac')|Specifies alternative output formats of the database schema, default is 'DacPac' to output a `.dacpac` single file. Additional options output one or more `.sql` files organized by either 'SchemaObjectType' (files in folders for each schema and object type), 'Schema' (files in folders for each schema), 'ObjectType' (files in folders for each object type), 'Flat' (all files in the same folder), or 'File' (1 single file).|
118-
|**/p:**|ExtractUsageProperties=(BOOLEAN)|Specifies whether usage properties, such as table row count and index size, will be extracted from the database.|
119-
|**/p:**|HashObjectNamesInLogs=(BOOLEAN)|Specifies whether to replace all object names in logs with a random hash value.|
120-
|**/p:**|IgnoreExtendedProperties=(BOOLEAN)|Specifies whether extended properties should be ignored.|
118+
|**/p:**|ExtractUsageProperties=(BOOLEAN 'False')|Specifies whether usage properties, such as table row count and index size, will be extracted from the database.|
119+
|**/p:**|HashObjectNamesInLogs=(BOOLEAN 'False')|Specifies whether to replace all object names in logs with a random hash value.|
120+
|**/p:**|IgnoreExtendedProperties=(BOOLEAN 'False')|Specifies whether extended properties should be ignored.|
121121
|**/p:**|IgnorePermissions=(BOOLEAN 'True')|Specifies whether permissions should be ignored.|
122-
|**/p:**|IgnoreUserLoginMappings=(BOOLEAN)|Specifies whether relationships between users and logins are ignored.|
122+
|**/p:**|IgnoreUserLoginMappings=(BOOLEAN 'False')|Specifies whether relationships between users and logins are ignored.|
123123
|**/p:**|LongRunningCommandTimeout=(INT32 '0')| Specifies the long running command timeout in seconds when executing queries against SQL Server. Use 0 to wait indefinitely.|
124124
|**/p:**|Storage=({File|Memory})|Specifies the type of backing storage for the schema model used during extraction. 'Memory' is default for .NET Core version of SqlPackage. 'File' is only available and default for .NET Framework version of SqlPackage.|
125125
|**/p:**|TableData=(STRING[])|Indicates the table from which data will be extracted. Specify the table name with or without the brackets surrounding the name parts in the following format: schema_name.table_identifier. This option may be specified multiple times.|

‎docs/tools/sqlpackage/sqlpackage-import.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 198198e2-7cf4-4a21-bda4-51b36cb4284b
99
author: "dzsquared"
1010
ms.author: "drskwier"
1111
ms.reviewer: "maghan"
12-
ms.date: 7/29/2022
12+
ms.date: 9/29/2022
1313
---
1414

1515
# SqlPackage Import parameters and properties
@@ -93,17 +93,17 @@ sqlpackage.exe /at:$($AccessToken_Object.Token) /Action:Import /SourceFile:"C:\A
9393
|**/p:**|CommandTimeout=(INT32 '60')|Specifies the command timeout in seconds when executing queries against SQL Server.|
9494
|**/p:**|DatabaseEdition=({ Basic | Standard | Premium | DataWarehouse | GeneralPurpose | BusinessCritical | Hyperscale | Default } 'Default')|Defines the edition of an Azure SQL Database. See [Azure SQL Database service tiers](/azure/azure-sql/database/service-tiers-general-purpose-business-critical).|
9595
|**/p:**|DatabaseLockTimeout=(INT32 '60')| Specifies the database lock timeout in seconds when executing queries against SQLServer. Use -1 to wait indefinitely.|
96-
|**/p:**|DatabaseMaximumSize=(INT32)|Defines the maximum size in GB of an Azure SQL Database.|
96+
|**/p:**|DatabaseMaximumSize=(INT32 '0')|Defines the maximum size in GB of an Azure SQL Database.|
9797
|**/p:**|DatabaseServiceObjective=(STRING)|Defines the performance level of an Azure SQL Database such as "P0" or "S1".|
98-
|**/p:**|DisableIndexesForDataPhase=(BOOLEAN TRUE)|When true (default), disables indexes before importing data. When false, indexes are not rebuilt. |
99-
|**/p:**|DisableParallelismForEnablingIndexes=(BOOLEAN)|Not using parallelism when rebuilding indexes while importing data into SQL Server.|
100-
|**/p:**|HashObjectNamesInLogs=(BOOLEAN)|Specifies whether to replace all object names in logs with a random hash value.|
98+
|**/p:**|DisableIndexesForDataPhase=(BOOLEAN 'True')|When true (default), disables indexes before importing data. When false, indexes are not rebuilt. |
99+
|**/p:**|DisableParallelismForEnablingIndexes=(BOOLEAN 'False')|Not using parallelism when rebuilding indexes while importing data into SQL Server.|
100+
|**/p:**|HashObjectNamesInLogs=(BOOLEAN 'False')|Specifies whether to replace all object names in logs with a random hash value.|
101101
|**/p:**|ImportContributorArguments=(STRING)|Specifies deployment contributor arguments for the deployment contributors. This property should be a semi-colon delimited list of values.|
102-
|**/p:**|ImportContributorPaths=(STRING)|Specifies paths to load additional deployment contributors. This property should be a semi-colon delimited list of values.|
102+
|**/p:**|ImportContributorPaths=(STRING)|Specifies paths to load additional import contributors. This property should be a semi-colon delimited list of values.|
103103
|**/p:**|ImportContributors=(STRING)|Specifies the deployment contributors, which should run when the bacpac is imported. This property should be a semi-colon delimited list of fully qualified build contributor names or IDs.|
104-
|**/p:**|LongRunningCommandTimeout=(INT32 '0')| Specifies the long running command timeout in seconds when executing queries against SQL Server. Use 0 to wait indefinitely.|
105-
|**/p:**|PreserveIdentityLastValues=(BOOLEAN)|Specifies whether last values for identity columns should be preserved during deployment.|
106-
|**/p:**|RebuildIndexesOfflineForDataPhase=(BOOLEAN FALSE)|When true, rebuilds indexes offline after importing data into SQL Server.|
104+
|**/p:**|LongRunningCommandTimeout=(INT32 '0')|Specifies the long running command timeout in seconds when executing queries against SQL Server. Use 0 to wait indefinitely.|
105+
|**/p:**|PreserveIdentityLastValues=(BOOLEAN 'False')|Specifies whether last values for identity columns should be preserved during deployment.|
106+
|**/p:**|RebuildIndexesOfflineForDataPhase=(BOOLEAN 'False')|When true, rebuilds indexes offline after importing data into SQL Server.|
107107
|**/p:**|Storage=({File|Memory})|Specifies how elements are stored when building the database model. For performance reasons the default is InMemory. For large databases, File backed storage is required.|
108108

109109
## Next Steps

0 commit comments

Comments
 (0)