Share via


TmdlSerializer.DeserializeDatabaseFromCompressedFile Method

Definition

Overloads

DeserializeDatabaseFromCompressedFile(String)

IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA!

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

DeserializeDatabaseFromCompressedFile(MetadataDeserializationOptions, String)

IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA!

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

DeserializeDatabaseFromCompressedFile(String)

IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA!

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

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

Exceptions

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

The specified path does not exist.

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

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.

Applies to

DeserializeDatabaseFromCompressedFile(MetadataDeserializationOptions, String)

IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA!

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

public static Microsoft.AnalysisServices.Database DeserializeDatabaseFromCompressedFile (Microsoft.AnalysisServices.Tabular.Serialization.MetadataDeserializationOptions options, string path);
static member DeserializeDatabaseFromCompressedFile : Microsoft.AnalysisServices.Tabular.Serialization.MetadataDeserializationOptions * string -> Microsoft.AnalysisServices.Database
Public Shared Function DeserializeDatabaseFromCompressedFile (options As MetadataDeserializationOptions, path As String) As Database

Parameters

options
MetadataDeserializationOptions

The options for the deserialization action.

path
String

The path to the compressed file.

Returns

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

Exceptions

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

The specified path does not exist.

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

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.

Applies to