Class ExportOptions

Namespace: DbExport

Assembly: DbExport.Api.dll

Options for exporting a database, including what to export and any provider-specific settings.

public class ExportOptions

Inheritance: object

ExportOptions

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ExportData

Determines whether the data within the tables of the database should be exported as part of the export process. When set to true, the contents of the tables, such as rows of data, will be included in the export.

public bool ExportData { get; set; }

Property Value

bool

ExportSchema

Indicates whether the schema of the database should be exported as part of the export process. When set to true, the structural definitions of tables, views, and other schema components will be included in the export.

public bool ExportSchema { get; set; }

Property Value

bool

Flags

Specifies the flags that determine which components of a database should be exported during the export process. This property allows combining multiple values from the ExportFlags enumeration to customize the export behavior, such as including or excluding primary keys, foreign keys, indexes, defaults, or identity columns.

public ExportFlags Flags { get; set; }

Property Value

ExportFlags

ProviderSpecific

Allows specifying provider-specific settings to be used during the export process. This property can hold configuration options or parameters unique to a particular database provider, enabling customization of the export behavior for that provider.

public dynamic ProviderSpecific { get; set; }

Property Value

dynamic

Methods

HasFlag(ExportFlags)

Checks if a specific flag in the ExportFlags enumeration is set.

public bool HasFlag(ExportFlags flag)

Parameters

flag ExportFlags: The flag to check for in the current ExportFlags value.

Returns

bool: A boolean value indicating whether the specified flag is set. Returns true if the flag is set; otherwise, false.

SetFlag(ExportFlags, bool)

Sets or clears a specific flag in the ExportFlags enumeration.

public void SetFlag(ExportFlags flag, bool value)

Parameters

flag ExportFlags: The flag to set or clear.
value bool: A boolean value indicating whether to set or clear the specified flag. If true, the flag will be set; if false, the flag will be cleared.