TmdlSerializer.SerializeDatabaseToCompressedFile Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| SerializeDatabaseToCompressedFile(Database, String) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Serializes a full in-memory Database to a set of TMDL documents in a comressed archive file, using the default serialization strategy. |
| SerializeDatabaseToCompressedFile(Database, MetadataSerializationOptions, String) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! 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)
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA!
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.Database db, string path);static member SerializeDatabaseToCompressedFile : Microsoft.AnalysisServices.Database * string -> unitPublic 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, MetadataSerializationOptions, String)
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA!
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.Database db, Microsoft.AnalysisServices.Tabular.Serialization.MetadataSerializationOptions options, string path);static member SerializeDatabaseToCompressedFile : Microsoft.AnalysisServices.Database * Microsoft.AnalysisServices.Tabular.Serialization.MetadataSerializationOptions * string -> unitPublic Shared Sub SerializeDatabaseToCompressedFile (db As Database, options As MetadataSerializationOptions, path As String)Parameters
- db
- Database
The database to serialize.
- options
- MetadataSerializationOptions
The options for the serialization action.
- 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 options instance is a null reference (Nothing in Visual Basic).
- The specified path is a null reference (Nothing in Visual Basic) or empty.
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.