TmdlSerializer.DeserializeDatabaseFromCompressedFile Method

Definition

Namespace:

Microsoft.AnalysisServices

Assembly:

Microsoft.AnalysisServices.dll

Package:

Microsoft.AnalysisServices v19.87.2

Overloads

DeserializeDatabaseFromCompressedFile(String)	Deserializes the set of TMDL documents in the specified compressed archive-file to its database object equivalent.
DeserializeDatabaseFromCompressedFile(String, MetadataDeserializationOptions)	Deserializes the set of TMDL documents in the specified compressed archive-file to its database object equivalent.

DeserializeDatabaseFromCompressedFile(String)

Deserializes the set of TMDL documents in the specified compressed archive-file to its database object equivalent.

public static Microsoft.AnalysisServices.Database DeserializeDatabaseFromCompressedFile (string path);

static member DeserializeDatabaseFromCompressedFile : string -> Microsoft.AnalysisServices.Database

Public Shared Function DeserializeDatabaseFromCompressedFile (path As String) As Database

Parameters

path

String

The path to the compressed file.

Returns

Database

The Database instance that was created based on the TMDL documents.

Exceptions

ArgumentNullException

The specified path is a null reference (Nothing in Visual Basic) or empty.

ArgumentException

The specified path does not exist.

TmdlFormatException

The content in the compressed file contains TMDL text in an invalid format.

TmdlSerializationException

The content in the compressed file contains TMDL text is in valid format, but contains invalid metadata.

Remarks

If the compressed file does not contain the properties of the database in any of the documents, the returned database will have default properties.

DeserializeDatabaseFromCompressedFile(String, MetadataDeserializationOptions)

Deserializes the set of TMDL documents in the specified compressed archive-file to its database object equivalent.

public static Microsoft.AnalysisServices.Database DeserializeDatabaseFromCompressedFile (string path, Microsoft.AnalysisServices.Tabular.Serialization.MetadataDeserializationOptions options);

static member DeserializeDatabaseFromCompressedFile : string * Microsoft.AnalysisServices.Tabular.Serialization.MetadataDeserializationOptions -> Microsoft.AnalysisServices.Database

Public Shared Function DeserializeDatabaseFromCompressedFile (path As String, options As MetadataDeserializationOptions) As Database

Parameters

path

String

The path to the compressed file.

options

MetadataDeserializationOptions

The options for the deserialization action.

Returns

Database

The Database instance that was created based on the TMDL documents.

Exceptions

ArgumentNullException

• The specified path is a null reference (Nothing in Visual Basic) or empty.
• The specified options instance is a null reference (Nothing in Visual Basic).

ArgumentException

The specified path does not exist.

TmdlFormatException

The content in the compressed file contains TMDL text in an invalid format.

TmdlSerializationException

The content in the compressed file contains TMDL text is in valid format, but contains invalid metadata.

Remarks

If the compressed file does not contain the properties of the database in any of the documents, the returned database will have default properties.