Share via


TmdlSerializer.SerializeDatabaseToCompressedFile Method

Definition

Overloads

SerializeDatabaseToCompressedFile(Database, String)

Serializes a full in-memory Database to a set of TMDL documents in a comressed archive file, using the default serialization strategy.

SerializeDatabaseToCompressedFile(Database, String, MetadataSerializationOptions)

Serializes a full in-memory Database to a set of TMDL documents in a comressed archive file, using the specified options and the default serialization strategy.

SerializeDatabaseToCompressedFile(Database, String)

Serializes a full in-memory Database to a set of TMDL documents in a comressed archive file, using the default serialization strategy.

public static void SerializeDatabaseToCompressedFile (Microsoft.AnalysisServices.Tabular.Database db, string path);
static member SerializeDatabaseToCompressedFile : Microsoft.AnalysisServices.Tabular.Database * string -> unit
Public Shared Sub SerializeDatabaseToCompressedFile (db As Database, path As String)

Parameters

db
Database

The database to serialize.

path
String

The path where the compressed file that contains the database documents will be saved.

Exceptions

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

Remarks

Apart from all the documents that include the serialization of the database child model, the properties of the database will be captured in a designated document as well.

Applies to

SerializeDatabaseToCompressedFile(Database, String, MetadataSerializationOptions)

Serializes a full in-memory Database to a set of TMDL documents in a comressed archive file, using the specified options and the default serialization strategy.

public static void SerializeDatabaseToCompressedFile (Microsoft.AnalysisServices.Tabular.Database db, string path, Microsoft.AnalysisServices.Tabular.Serialization.MetadataSerializationOptions options);
static member SerializeDatabaseToCompressedFile : Microsoft.AnalysisServices.Tabular.Database * string * Microsoft.AnalysisServices.Tabular.Serialization.MetadataSerializationOptions -> unit
Public Shared Sub SerializeDatabaseToCompressedFile (db As Database, path As String, options As MetadataSerializationOptions)

Parameters

db
Database

The database to serialize.

path
String

The path where the compressed file that contains the database documents will be saved.

options
MetadataSerializationOptions

The options for the serialization action.

Exceptions

  • The specified database is a null reference (Nothing in Visual Basic).
  • 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).

The provided options include invalid settings.

Remarks

Apart from all the documents that include the serialization of the database child model, the properties of the database will be captured in a designated document as well.

Applies to