Class FirebirdCodeGenerator

Namespace: DbExport.Providers.Firebird

Assembly: DbExport.Api.dll

Generates SQL code specific to the Firebird database system. This class provides methods to process various database objects and options, translating them into Firebird-compatible SQL scripts.

public class FirebirdCodeGenerator : CodeGenerator, IVisitor, IDisposable

Inheritance: object

CodeGenerator

FirebirdCodeGenerator

Implements: IVisitor

IDisposable

Inherited Members: CodeGenerator.Get(string, TextWriter)

CodeGenerator.ExportOptions

CodeGenerator.Output

CodeGenerator.SupportsDbCreation

CodeGenerator.GeneratesRowVersion

CodeGenerator.RequireInlineConstraints

CodeGenerator.Dispose()

CodeGenerator.Dispose(bool)

CodeGenerator.VisitDatabase(Database)

CodeGenerator.VisitTable(Table)

CodeGenerator.VisitColumn(Column)

CodeGenerator.VisitPrimaryKey(PrimaryKey)

CodeGenerator.VisitIndex(Index)

CodeGenerator.VisitForeignKey(ForeignKey)

CodeGenerator.Escape(string)

CodeGenerator.GetTypeName(Column)

CodeGenerator.WriteComment(string, params object[])

CodeGenerator.WriteDelimiter()

CodeGenerator.WriteIdentitySpecification(Column)

CodeGenerator.WriteTableCreationSuffix(Table)

CodeGenerator.WriteDataMigrationPrefix()

CodeGenerator.WriteDataMigrationSuffix()

CodeGenerator.GetForeignKeyRuleText(ForeignKeyRule)

CodeGenerator.WriteInsertDirective(Table, DbDataReader)

CodeGenerator.Indent()

CodeGenerator.Unindent()

CodeGenerator.Write(char)

CodeGenerator.Write(string)

CodeGenerator.Write(string, params object[])

CodeGenerator.WriteLine()

CodeGenerator.WriteLine(string)

CodeGenerator.WriteLine(string, params object[])

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FirebirdCodeGenerator()

Initializes a new instance of the FirebirdCodeGenerator class.

public FirebirdCodeGenerator()

FirebirdCodeGenerator(TextWriter)

Initializes a new instance of the FirebirdCodeGenerator class with the specified TextWriter for output.

public FirebirdCodeGenerator(TextWriter output)

Parameters

output TextWriter: The TextWriter to which the generated SQL will be written. Must not be null.

FirebirdCodeGenerator(string)

Initializes a new instance of the FirebirdCodeGenerator class that writes output to a file at the specified path.

public FirebirdCodeGenerator(string path)

Parameters

path string: The file path where the generated SQL will be written. Must not be null or empty.

Properties

FirebirdOptions

Represents configuration options specific to Firebird database generation.

public FirebirdOptions FirebirdOptions { get; }

Property Value

FirebirdOptions

ProviderName

Gets the name of the database provider for which this code generator is designed to generate SQL scripts.

public override string ProviderName { get; }

Property Value

string

Methods

Format(object, ColumnType)

Formats a value for inclusion in a SQL statement, taking into account the value's type and the corresponding column type.

protected override string Format(object value, ColumnType columnType)

Parameters

value object: The value to be formatted for inclusion in a SQL statement. This could be a default value for a column, a value being inserted into a table, or any other value that needs to be represented as a literal in the generated SQL. The method will determine how to format this value based on its type and the specified column type, ensuring that it is correctly represented in the SQL syntax for the target database provider.
columnType ColumnType: The column type that corresponds to the value being formatted. This information is used to determine how to format the value, such as whether to quote it, how to format dates and times, how to represent binary data, etc., according to the conventions of the target database provider.

Returns

string: A string representing the formatted value, ready to be included as a literal in a SQL statement, formatted according to the conventions of the target database provider.

GetKeyName(Key)

Gets the name to be used for a key (such as an index or foreign key constraint) in the generated SQL.

protected override string GetKeyName(Key key)

Parameters

key Key: The key for which to get the name. This method is called when generating SQL for indexes and foreign key constraints, and it determines how to name these keys in the generated SQL. The default implementation returns the escaped name of the key, but derived classes can override this method to provide different naming conventions or to include additional information in the key name as needed by the target database provider.

Returns

string: A string representing the name to be used for the key in the generated SQL, formatted according to the conventions of the target database provider.

GetTypeName(IDataItem)

Gets the SQL type name for the given data item, which could be a column or a user-defined data type.

protected override string GetTypeName(IDataItem item)

Parameters

item IDataItem: The data item for which to determine the SQL type name. This could be a column or a user-defined data type. The method will use the properties of the data item, such as ColumnType, Size, Precision, and Scale, to determine the appropriate SQL type name, potentially using provider-specific type mappings and formatting rules.

Returns

string: A string representing the SQL type name for the data item, formatted according to the conventions of the target database provider.

GetTypeReference(DataType)

Gets the SQL type reference for a user-defined data type, which may involve referencing the data type by name or using a specific syntax depending on the target database provider.

protected override string GetTypeReference(DataType dataType)

Parameters

dataType DataType: The user-defined data type for which to get the SQL type reference. This method is called when a column has a ColumnType of UserDefined, and the column's DataType property is not null. The method will determine how to reference this user-defined data type in the generated SQL, which may involve using the data type's name or a specific syntax depending on the conventions of the target database provider.

Returns

string: A string representing the SQL type reference for the user-defined data type, formatted according to the conventions of the target database provider.

VisitDataType(DataType)

Visits a DataType object, allowing the visitor to perform operations on the data type schema.

public override void VisitDataType(DataType dataType)

Parameters

dataType DataType: The DataType object to be visited.

WriteDbCreationDirective(Database)

Writes a CREATE DATABASE statement for the given database, according to the syntax rules of the target database provider.

protected override void WriteDbCreationDirective(Database database)

Parameters

database Database: The database for which to write the CREATE DATABASE statement. This method will generate the appropriate SQL to create the database, including the database name and any necessary syntax according to the conventions of the target database provider. This method is called if the code generator supports database creation and if the export options indicate that the schema should be exported.

WriteDeleteRule(ForeignKeyRule)

Writes the syntax for the ON DELETE clause of a foreign key constraint, based on the specified delete rule.

protected override void WriteDeleteRule(ForeignKeyRule deleteRule)

Parameters

deleteRule ForeignKeyRule: The foreign key rule that specifies the action to be taken when a referenced row is deleted. This method will generate the appropriate SQL syntax for the ON DELETE clause of a foreign key constraint, based on the value of the deleteRule parameter, which can indicate actions such as CASCADE, SET NULL, SET DEFAULT, etc., according to the conventions of the target database provider.

WriteUpdateRule(ForeignKeyRule)

Writes the syntax for the ON UPDATE clause of a foreign key constraint, based on the specified update rule.

protected override void WriteUpdateRule(ForeignKeyRule updateRule)

Parameters

updateRule ForeignKeyRule: The foreign key rule that specifies the action to be taken when a referenced row is updated. This method will generate the appropriate SQL syntax for the ON UPDATE clause of a foreign key constraint, based on the value of the updateRule parameter, which can indicate actions such as CASCADE, SET NULL, SET DEFAULT, etc., according to the conventions of the target database provider.