JsonScripter.ScriptRefresh Method

Reference

Definition

Namespace:: Microsoft.AnalysisServices.Tabular

Assembly:: Microsoft.AnalysisServices.Tabular.dll

Package:: Microsoft.AnalysisServices.retail.amd64 v19.80.0

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

ScriptRefresh(ICollection<NamedMetadataObject>, RefreshType, DateTime)	Scripts out multiple tabular metadata object into a Refresh command using a specified RefreshType and specified effective date to apply to the refresh-policy.
ScriptRefresh(ICollection<NamedMetadataObject>, RefreshType, RefreshPolicyBehavior)	Scripts out multiple tabular metadata object into a Refresh command using a specified RefreshType and specified refresh-policy behavior.
ScriptRefresh(NamedMetadataObject, RefreshType, DateTime)	Scripts out a given tabular metadata object into a Refresh command using a specified RefreshType and specified effective date to apply to the refresh-policy.
ScriptRefresh(Database, RefreshType, DateTime)	Scripts out a given tabular database into a Refresh command using a specified RefreshType and specified effective date to apply to the refresh-policy.
ScriptRefresh(Database, RefreshType, RefreshPolicyBehavior)	Scripts out a given tabular database into a Refresh command using a specified RefreshType and specified refresh-policy behavior.
ScriptRefresh(ICollection<NamedMetadataObject>, RefreshType)	Scripts out multiple tabular metadata object into a Refresh command.
ScriptRefresh(NamedMetadataObject, RefreshType, RefreshPolicyBehavior)	Scripts out a given tabular metadata object into a Refresh command using a specified RefreshType and specified refresh-policy behavior.
ScriptRefresh(NamedMetadataObject, RefreshType)	Scripts out a given tabular metadata object into a Refresh command using a specified RefreshType.
ScriptRefresh(Database, DateTime)	Obsolete. Scripts out a given tabular database into a Refresh command using a specified effective date to apply to the refresh-policy.
ScriptRefresh(Database, RefreshType)	Scripts out a given tabular database into a Refresh command using a specified RefreshType.
ScriptRefresh(NamedMetadataObject)	Scripts out a given tabular metadata object into a Refresh command using the default refresh-type.
ScriptRefresh(Database)	Scripts out a given tabular database into a Refresh command.
ScriptRefresh(NamedMetadataObject, DateTime)	Obsolete. Scripts out a given tabular metadata object into a Refresh command using the specified effective date to apply to the refresh-policy.

ScriptRefresh(ICollection<NamedMetadataObject>, RefreshType, DateTime)

Scripts out multiple tabular metadata object into a Refresh command using a specified RefreshType and specified effective date to apply to the refresh-policy.

public static string ScriptRefresh (System.Collections.Generic.ICollection<Microsoft.AnalysisServices.Tabular.NamedMetadataObject> objects, Microsoft.AnalysisServices.Tabular.RefreshType refreshType, DateTime effectiveDate);

static member ScriptRefresh : System.Collections.Generic.ICollection<Microsoft.AnalysisServices.Tabular.NamedMetadataObject> * Microsoft.AnalysisServices.Tabular.RefreshType * DateTime -> string

Public Shared Function ScriptRefresh (objects As ICollection(Of NamedMetadataObject), refreshType As RefreshType, effectiveDate As DateTime) As String

Parameters

objects: ICollection<NamedMetadataObject>

A collection of tabular metadata object to script.

refreshType: RefreshType

The type of refresh.

effectiveDate: DateTime

Effective date for incremental refresh.

Returns

String

A String containing the Refresh command.

Applies to

ScriptRefresh(ICollection<NamedMetadataObject>, RefreshType, RefreshPolicyBehavior)

Scripts out multiple tabular metadata object into a Refresh command using a specified RefreshType and specified refresh-policy behavior.

public static string ScriptRefresh (System.Collections.Generic.ICollection<Microsoft.AnalysisServices.Tabular.NamedMetadataObject> objects, Microsoft.AnalysisServices.Tabular.RefreshType refreshType, Microsoft.AnalysisServices.Tabular.RefreshPolicyBehavior behavior);

static member ScriptRefresh : System.Collections.Generic.ICollection<Microsoft.AnalysisServices.Tabular.NamedMetadataObject> * Microsoft.AnalysisServices.Tabular.RefreshType * Microsoft.AnalysisServices.Tabular.RefreshPolicyBehavior -> string

Public Shared Function ScriptRefresh (objects As ICollection(Of NamedMetadataObject), refreshType As RefreshType, behavior As RefreshPolicyBehavior) As String

Parameters

objects: ICollection<NamedMetadataObject>

A collection of tabular metadata object to script.

refreshType: RefreshType

The type of refresh.

behavior: RefreshPolicyBehavior

Behavior for refresh-policy handling.

Returns

String

A String containing the Refresh command.

Applies to

ScriptRefresh(NamedMetadataObject, RefreshType, DateTime)

Scripts out a given tabular metadata object into a Refresh command using a specified RefreshType and specified effective date to apply to the refresh-policy.

public static string ScriptRefresh (Microsoft.AnalysisServices.Tabular.NamedMetadataObject obj, Microsoft.AnalysisServices.Tabular.RefreshType refreshType, DateTime effectiveDate);

static member ScriptRefresh : Microsoft.AnalysisServices.Tabular.NamedMetadataObject * Microsoft.AnalysisServices.Tabular.RefreshType * DateTime -> string

Public Shared Function ScriptRefresh (obj As NamedMetadataObject, refreshType As RefreshType, effectiveDate As DateTime) As String

Parameters

obj: NamedMetadataObject

The tabular metadata object to script.

refreshType: RefreshType

The type of refresh.

effectiveDate: DateTime

Effective date for incremental refresh.

Returns

String

A String containing the Refresh command.

Applies to

ScriptRefresh(Database, RefreshType, DateTime)

Scripts out a given tabular database into a Refresh command using a specified RefreshType and specified effective date to apply to the refresh-policy.

public static string ScriptRefresh (Microsoft.AnalysisServices.Core.Database db, Microsoft.AnalysisServices.Tabular.RefreshType refreshType, DateTime effectiveDate);

static member ScriptRefresh : Microsoft.AnalysisServices.Core.Database * Microsoft.AnalysisServices.Tabular.RefreshType * DateTime -> string

Public Shared Function ScriptRefresh (db As Database, refreshType As RefreshType, effectiveDate As DateTime) As String

Parameters

db: Database

The tabular database to script.

refreshType: RefreshType

The type of refresh.

effectiveDate: DateTime

Effective date for incremental refresh

Returns

String

A String containing the Refresh command.

Applies to

ScriptRefresh(Database, RefreshType, RefreshPolicyBehavior)

Scripts out a given tabular database into a Refresh command using a specified RefreshType and specified refresh-policy behavior.

public static string ScriptRefresh (Microsoft.AnalysisServices.Core.Database db, Microsoft.AnalysisServices.Tabular.RefreshType refreshType, Microsoft.AnalysisServices.Tabular.RefreshPolicyBehavior behavior);

static member ScriptRefresh : Microsoft.AnalysisServices.Core.Database * Microsoft.AnalysisServices.Tabular.RefreshType * Microsoft.AnalysisServices.Tabular.RefreshPolicyBehavior -> string

Public Shared Function ScriptRefresh (db As Database, refreshType As RefreshType, behavior As RefreshPolicyBehavior) As String

Parameters

db: Database

The tabular database to script.

refreshType: RefreshType

The type of refresh.

behavior: RefreshPolicyBehavior

Behavior for refresh-policy handling.

Returns

String

A String containing the Refresh command.

Applies to

ScriptRefresh(ICollection<NamedMetadataObject>, RefreshType)

Scripts out multiple tabular metadata object into a Refresh command.

public static string ScriptRefresh (System.Collections.Generic.ICollection<Microsoft.AnalysisServices.Tabular.NamedMetadataObject> objects, Microsoft.AnalysisServices.Tabular.RefreshType refreshType);

static member ScriptRefresh : System.Collections.Generic.ICollection<Microsoft.AnalysisServices.Tabular.NamedMetadataObject> * Microsoft.AnalysisServices.Tabular.RefreshType -> string

Public Shared Function ScriptRefresh (objects As ICollection(Of NamedMetadataObject), refreshType As RefreshType) As String

Parameters

objects: ICollection<NamedMetadataObject>

A collection of tabular metadata object to script.

refreshType: RefreshType

The type of refresh.

Returns

String

A String containing the Refresh command.

Applies to

ScriptRefresh(NamedMetadataObject, RefreshType, RefreshPolicyBehavior)

Scripts out a given tabular metadata object into a Refresh command using a specified RefreshType and specified refresh-policy behavior.

public static string ScriptRefresh (Microsoft.AnalysisServices.Tabular.NamedMetadataObject obj, Microsoft.AnalysisServices.Tabular.RefreshType refreshType, Microsoft.AnalysisServices.Tabular.RefreshPolicyBehavior behavior);

static member ScriptRefresh : Microsoft.AnalysisServices.Tabular.NamedMetadataObject * Microsoft.AnalysisServices.Tabular.RefreshType * Microsoft.AnalysisServices.Tabular.RefreshPolicyBehavior -> string

Public Shared Function ScriptRefresh (obj As NamedMetadataObject, refreshType As RefreshType, behavior As RefreshPolicyBehavior) As String

Parameters

obj: NamedMetadataObject

The tabular metadata object to script.

refreshType: RefreshType

The type of refresh.

behavior: RefreshPolicyBehavior

Behavior for refresh-policy handling.

Returns

String

A String containing the Refresh command.

Applies to

ScriptRefresh(NamedMetadataObject, RefreshType)

Scripts out a given tabular metadata object into a Refresh command using a specified RefreshType.

public static string ScriptRefresh (Microsoft.AnalysisServices.Tabular.NamedMetadataObject obj, Microsoft.AnalysisServices.Tabular.RefreshType refreshType);

static member ScriptRefresh : Microsoft.AnalysisServices.Tabular.NamedMetadataObject * Microsoft.AnalysisServices.Tabular.RefreshType -> string

Public Shared Function ScriptRefresh (obj As NamedMetadataObject, refreshType As RefreshType) As String

Parameters

obj: NamedMetadataObject

The tabular metadata object to script.

refreshType: RefreshType

The type of refresh.

Returns

String

A String containing the Refresh command.

Applies to

ScriptRefresh(Database, DateTime)

Caution

Deprecated. Use the ScriptRefresh(Database, RefreshType, DateTime) overload that also accepts the refresh-type as parameter instead.

Scripts out a given tabular database into a Refresh command using a specified effective date to apply to the refresh-policy.

[System.Obsolete("Deprecated. Use the ScriptRefresh(Database, RefreshType, DateTime) overload that also accepts the refresh-type as parameter instead.")]
public static string ScriptRefresh (Microsoft.AnalysisServices.Core.Database db, DateTime effectiveDate);

[<System.Obsolete("Deprecated. Use the ScriptRefresh(Database, RefreshType, DateTime) overload that also accepts the refresh-type as parameter instead.")>]
static member ScriptRefresh : Microsoft.AnalysisServices.Core.Database * DateTime -> string

Public Shared Function ScriptRefresh (db As Database, effectiveDate As DateTime) As String

Parameters

db: Database

The tabular database to script.

effectiveDate: DateTime

Effective date for incremental refresh

Returns

String

A String containing the Refresh command.

Attributes: ObsoleteAttribute

Applies to

ScriptRefresh(Database, RefreshType)

Scripts out a given tabular database into a Refresh command using a specified RefreshType.

public static string ScriptRefresh (Microsoft.AnalysisServices.Core.Database db, Microsoft.AnalysisServices.Tabular.RefreshType refreshType);

static member ScriptRefresh : Microsoft.AnalysisServices.Core.Database * Microsoft.AnalysisServices.Tabular.RefreshType -> string

Public Shared Function ScriptRefresh (db As Database, refreshType As RefreshType) As String

Parameters

db: Database

The tabular database to script.

refreshType: RefreshType

Type of refresh.

Returns

String

A String containing the Refresh command.

Applies to

ScriptRefresh(NamedMetadataObject)

Scripts out a given tabular metadata object into a Refresh command using the default refresh-type.

public static string ScriptRefresh (Microsoft.AnalysisServices.Tabular.NamedMetadataObject obj);

static member ScriptRefresh : Microsoft.AnalysisServices.Tabular.NamedMetadataObject -> string

Public Shared Function ScriptRefresh (obj As NamedMetadataObject) As String

Parameters

obj: NamedMetadataObject

The tabular metadata object to script.

Returns

String

A String containing the Refresh command.

Applies to

ScriptRefresh(Database)

Scripts out a given tabular database into a Refresh command.

public static string ScriptRefresh (Microsoft.AnalysisServices.Core.Database db);

static member ScriptRefresh : Microsoft.AnalysisServices.Core.Database -> string

Public Shared Function ScriptRefresh (db As Database) As String

Parameters

db: Database

The tabular database to script.

Returns

String

A String containing the Refresh command.

Applies to

ScriptRefresh(NamedMetadataObject, DateTime)

Caution

Deprecated. Use the ScriptRefresh(NamedMetadataObject, RefreshType, DateTime) overload that also accepts the refresh-type as parameter instead.

Scripts out a given tabular metadata object into a Refresh command using the specified effective date to apply to the refresh-policy.

[System.Obsolete("Deprecated. Use the ScriptRefresh(NamedMetadataObject, RefreshType, DateTime) overload that also accepts the refresh-type as parameter instead.")]
public static string ScriptRefresh (Microsoft.AnalysisServices.Tabular.NamedMetadataObject obj, DateTime effectiveDate);

[<System.Obsolete("Deprecated. Use the ScriptRefresh(NamedMetadataObject, RefreshType, DateTime) overload that also accepts the refresh-type as parameter instead.")>]
static member ScriptRefresh : Microsoft.AnalysisServices.Tabular.NamedMetadataObject * DateTime -> string

Public Shared Function ScriptRefresh (obj As NamedMetadataObject, effectiveDate As DateTime) As String

Parameters

obj: NamedMetadataObject

The tabular metadata object to script.

effectiveDate: DateTime

Effective date for incremental refresh.

Returns

String

A String containing the Refresh command.

Attributes: ObsoleteAttribute

Applies to

Share via

JsonScripter.ScriptRefresh Method

Definition

Overloads

ScriptRefresh(ICollection<NamedMetadataObject>, RefreshType, DateTime)

Parameters

Returns

Applies to

ScriptRefresh(ICollection<NamedMetadataObject>, RefreshType, RefreshPolicyBehavior)

Parameters

Returns

Applies to

ScriptRefresh(NamedMetadataObject, RefreshType, DateTime)

Parameters

Returns

Applies to

ScriptRefresh(Database, RefreshType, DateTime)

Parameters

Returns

Applies to

ScriptRefresh(Database, RefreshType, RefreshPolicyBehavior)

Parameters

Returns

Applies to

ScriptRefresh(ICollection<NamedMetadataObject>, RefreshType)

Parameters

Returns

Applies to

ScriptRefresh(NamedMetadataObject, RefreshType, RefreshPolicyBehavior)

Parameters

Returns

Applies to

ScriptRefresh(NamedMetadataObject, RefreshType)

Parameters

Returns

Applies to

ScriptRefresh(Database, DateTime)

Parameters

Returns

Applies to

ScriptRefresh(Database, RefreshType)

Parameters

Returns

Applies to

ScriptRefresh(NamedMetadataObject)

Parameters

Returns

Applies to

ScriptRefresh(Database)

Parameters

Returns

Applies to

ScriptRefresh(NamedMetadataObject, DateTime)

Parameters

Returns

Applies to

Additional resources