TmdlSerializer.SerializeDatabaseToDocumentCollection Method

  • Reference

Definition

Namespace:
Microsoft.AnalysisServices
Assembly:
Microsoft.AnalysisServices.dll
Package:
Microsoft.AnalysisServices.retail.amd64 v19.82.0

Overloads

SerializeDatabaseToDocumentCollection(Database, MetadataSerializationContext, Object)

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

Load the set of documents that represent the provided database into the context.
SerializeDatabaseToDocumentCollection(Database, MetadataSerializationContext, MetadataSerializationOptions, Object)

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

Load the set of documents that represent the provided database into the context using the given options.

SerializeDatabaseToDocumentCollection(Database, MetadataSerializationContext, Object)

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

Load the set of documents that represent the provided database into the context.

public static void SerializeDatabaseToDocumentCollection (Microsoft.AnalysisServices.Database db, Microsoft.AnalysisServices.Tabular.Serialization.MetadataSerializationContext serializationContext, object userContext = default);
static member SerializeDatabaseToDocumentCollection : Microsoft.AnalysisServices.Database * Microsoft.AnalysisServices.Tabular.Serialization.MetadataSerializationContext * obj -> unit
Public Shared Sub SerializeDatabaseToDocumentCollection (db As Database, serializationContext As MetadataSerializationContext, Optional userContext As Object = Nothing)

Parameters

db
Database

A Database that is the source for the metadata.

serializationContext
MetadataSerializationContext

The serialization context.

userContext
Object

An optional user context that will be associated with the serialization operation.

Exceptions

ArgumentNullException
  • The specified database is a null reference (Nothing in Visual Basic).
  • The specified serialization-context is a null reference (Nothing in Visual Basic).

Remarks

Any metadata documents that are loaded in the context prior to the execution will be removed.

If a user-context is specified it will be included in the notifications to the serialization host.

Applies to

SerializeDatabaseToDocumentCollection(Database, MetadataSerializationContext, MetadataSerializationOptions, Object)

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

Load the set of documents that represent the provided database into the context using the given options.

public static void SerializeDatabaseToDocumentCollection (Microsoft.AnalysisServices.Database db, Microsoft.AnalysisServices.Tabular.Serialization.MetadataSerializationContext serializationContext, Microsoft.AnalysisServices.Tabular.Serialization.MetadataSerializationOptions options, object userContext = default);
static member SerializeDatabaseToDocumentCollection : Microsoft.AnalysisServices.Database * Microsoft.AnalysisServices.Tabular.Serialization.MetadataSerializationContext * Microsoft.AnalysisServices.Tabular.Serialization.MetadataSerializationOptions * obj -> unit
Public Shared Sub SerializeDatabaseToDocumentCollection (db As Database, serializationContext As MetadataSerializationContext, options As MetadataSerializationOptions, Optional userContext As Object = Nothing)

Parameters

db
Database

A Database that is the source for the metadata.

serializationContext
MetadataSerializationContext

The serialization context.

options
MetadataSerializationOptions

The options for the serialization operation.

userContext
Object

An optional user context that will be associated with the serialization operation.

Exceptions

ArgumentNullException
  • The specified database is a null reference (Nothing in Visual Basic).
  • The specified serialization-context is a null reference (Nothing in Visual Basic).
  • The specified options instance is a null reference (Nothing in Visual Basic).
InvalidOperationException

The provided options include invalid settings.

Remarks

Any metadata documents that are loaded in the context prior to the execution will be removed.

If a user-context is specified it will be included in the notifications to the serialization host.

Applies to