Skip to content

Commit

Permalink
Merge pull request #8 from DbUp/issue/5_documentation
Browse files Browse the repository at this point in the history
Fixed documentation to describe the quirk regarding schemaversions
  • Loading branch information
droyad authored Aug 1, 2024
2 parents 108f914 + 9757886 commit 867c8a1
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
[![Prerelease](https://img.shields.io/nuget/vpre/dbup-firebird?color=orange&label=prerelease)](https://www.nuget.org/packages/dbup-firebird)

# DbUp Firebird support
DbUp is a .NET library that helps you to deploy changes to SQL Server databases. It tracks which SQL scripts have been run already, and runs the change scripts that are needed to get your database up to date.
DbUp is a .NET library that helps you to deploy changes to relational databases. It tracks which SQL scripts have been run already, and runs the change scripts that are needed to get your database up to date.
This Provider is for deploying to Firebird databases.

## Getting Help
To learn more about DbUp check out the [documentation](https://dbup.readthedocs.io/en/latest/)
Expand All @@ -13,4 +14,24 @@ Please only log issue related to Firebird support in this repo. For cross cuttin

# Contributing

See the [readme in our main repo](https://github.com/DbUp/DbUp/blob/master/README.md) for how to get started and contribute.
See the [readme in our main repo](https://github.com/DbUp/DbUp/blob/master/README.md) for how to get started and contribute.

# Quirks concerning the Firebird implementation

The Journal Table for Firebird is called `"schemaversions"` i.e. with quotes. This can be confusing since other providers do not use quotes.

It will not be fixed because of backwards compatibility. You can check the content of the table by using

```sql
select * from "schemaversions"
```

In a new project you can also choose another name for the JournalTable instead like this:

```csharp
public static UpgradeEngineBuilder JournalToFirebirdTable(this UpgradeEngineBuilder builder)
{
builder.Configure(c => c.Journal = new FirebirdTableJournal(() => c.ConnectionManager, () => c.Log, "ABetterTableName"));
return builder;

```

0 comments on commit 867c8a1

Please sign in to comment.