Share via

Test-NAVTenantDatabaseSchema

Module:
Microsoft.Dynamics.Nav.Management Module

Checks for any errors in the tenant database schema.

Syntax

Default (Default) 

Test-NAVTenantDatabaseSchema
    [-ServerInstance] <String>
    [-Tenant <TenantId>]
    [-Force]
    [<CommonParameters>]

Description

You use the Test-NAVTenantDatabaseSchema cmdlet to compare the tables in the tenant database to the expected metadata of the tables known to the server. This will help to proactively identify errors in the schema.

The tenant database must first be synchronized before its schema can be analyzed.

Examples

EXAMPLE 1

Test-NAVTenantDatabaseSchema -ServerInstance BC -Tenant Tenant1

This example tests the schema of the database belonging to Tenant1, that is mounted against the specified Business Central Server instance.

Parameters

-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, BC or myinstance. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$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 you want to check schema for, 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

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 by property name: ServerInstance

Microsoft.Dynamics.Nav.Types.TenantId

By property name: Tenant