Skip to content

Commit 867c8a1

Browse files
authored
Merge pull request #8 from DbUp/issue/5_documentation
Fixed documentation to describe the quirk regarding schemaversions
2 parents 108f914 + 9757886 commit 867c8a1

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
[![Prerelease](https://img.shields.io/nuget/vpre/dbup-firebird?color=orange&label=prerelease)](https://www.nuget.org/packages/dbup-firebird)
55

66
# DbUp Firebird support
7-
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.
7+
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.
8+
This Provider is for deploying to Firebird databases.
89

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

1415
# Contributing
1516

16-
See the [readme in our main repo](https://github.com/DbUp/DbUp/blob/master/README.md) for how to get started and contribute.
17+
See the [readme in our main repo](https://github.com/DbUp/DbUp/blob/master/README.md) for how to get started and contribute.
18+
19+
# Quirks concerning the Firebird implementation
20+
21+
The Journal Table for Firebird is called `"schemaversions"` i.e. with quotes. This can be confusing since other providers do not use quotes.
22+
23+
It will not be fixed because of backwards compatibility. You can check the content of the table by using
24+
25+
```sql
26+
select * from "schemaversions"
27+
```
28+
29+
In a new project you can also choose another name for the JournalTable instead like this:
30+
31+
```csharp
32+
public static UpgradeEngineBuilder JournalToFirebirdTable(this UpgradeEngineBuilder builder)
33+
{
34+
builder.Configure(c => c.Journal = new FirebirdTableJournal(() => c.ConnectionManager, () => c.Log, "ABetterTableName"));
35+
return builder;
36+
37+
```

0 commit comments

Comments
 (0)