Start-NAVDatabaseCompression
Starts the compression of a tenant database. This will compress any tables that do not have an explicit compression level specified to the database default level.
Syntax
Default (Default)
Start-NAVDatabaseCompression
[-ServerInstance] <String>
[-Timeout <TimeSpan>]
[-Compression <CompressionType>]
[-Tenant <TenantId>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
You must specify a Business Central Server instance and tenant. For more info on SQL Server data compression and relevant terminology, see https://docs.microsoft.com/sql/relational-databases/data-compression/data-compression
Examples
EXAMPLE 1
Start-NAVDatabaseCompression -ServerInstance BusinessCentral -Tenant t1
Start compressing the tables in tenant t1.
Parameters
-Compression
Specifies the compression level to use. If this parameter is not set or set to Unspecified the database default level will be used. Specifying a parameter different from Unspecified will also update the database default compression level.
Possible values: Unspecified, None, Row, Page
Parameter properties
| Type: | CompressionType |
| Default value: | Unspecified |
| Accepted values: | Unspecified, None, Row, Page |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ServerInstance
Specifies the name of a Business Central Server instance, for example, BusinessCentral or myinstance. You can specify either the full name of an instance, such as BusinessCentralServer$myinstance or the short name, such as myinstance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Tenant
Specifies the ID of the tenant that should be compressed, such as Tenant1.
This parameter is required unless the specified service instance is not configured to run multiple tenants.
Parameter properties
| Type: | TenantId |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Id |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Timeout
Specifies the duration the compression is allowed to execute for. The compression will stop after the time has elapsed and any remaining tables will be left uncompressed. A timeout of 0 means the command will continue untill all tables have been compressed.
Parameter properties
| Type: | TimeSpan |
| Default value: | 00:00:00 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
System.String
By value and property name: ServerInstance
System.TimeSpan
By property name: Timeout
Microsoft.Dynamics.Nav.Types.Metadata.CompressionType
By property name: Timeout
Microsoft.Dynamics.Nav.Types.TenantId
By property name: Tenant
Notes
In a single-tenant installation one database contains both the per-tenant tables and the cross-tenant tables. Even in this configuration it is only the per-tenant tables that are compressed.