Releases: IntersectMBO/cardano-db-sync
Cardano DB Sync 13.6.0.4
It is required that users upgrade to this version of db-sync.
DB Sync 13.6.0.4 is a mainnet-ready release that is capable of crossing the Chang#2 hard fork. This update addresses a ledger issue where DRep delegations could be removed under some conditions.
Upgrading from older 13.5.x.x db-sync instance requires a ledger state replay from genesis. This doesn't affect the database.
The release is compatible with both 13.6 and 13.5 snapshots. These can be found at:
| Network | Link to snapshot |
|---|---|
| Mainnet-13.6 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.6/ |
| Mainnet-13.5 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.5/ |
Changelog
https://github.com/IntersectMBO/cardano-db-sync/blob/13.6.0.4/CHANGELOG.md#13604
Known issues
For networks that were already in Protocol Version 10 (e.g. Preview and PreProd) before the upgrade to this release, the values of drep_distribution before the upgrade are not well defined and could be slightly different between different executions. This shouldn't have any cascading effect. For these networks it is advised to delete all ledger state files and let the ledger rules replay from genesis. You can read more about this issue here,
Documentation
Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash
Postgres setup
It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:
It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)
Notes
When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented in configuration.md.
Platforms
- Linux 64-bit
- Docker
Requiresghc-8.10.xto build.
Sign off
| Role | Approval |
|---|---|
| Technical Lead | 🟢 |
| Cardano Head of Engineering | 🟢 |
| Cardano Head of Product | 🟢 |
| Test Engineer | 🟢 |
| Site Reliability Engineer | 🟢 |
13.6.0.3-consumed
kderme
Kostas Dermentzis
Fixes an issue with migration from 13.5.0.x when the consumed_tx_out config is enabled
Cardano DB Sync 13.6.0.2
This release is compatible with node-10.1.2 and supports the Chang#2 HF in mainnet. It fixes an issue of 13.6.0.1 where rollbacks were too slow.
Upgrading from any 13.5.x.x db-sync instance requires a ledger state replay from genesis. This doesn't affect the database.
It is compatible with 13.6 and 13.5 snapshots. They can be found at:
| Network | Link to snapshot |
|---|---|
| Mainnet-13.6 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.6/ |
| Mainnet-13.5 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.5/ |
Changelog
https://github.com/IntersectMBO/cardano-db-sync/blob/13.6.0.2/CHANGELOG.md#13602
Documentation
Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash
Postgres setup
It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:
It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)
Notes
When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented here configuration.md
Platforms
- Linux 64-bit
- Docker
Requiresghc-8.10.xto build.
Sign off
| Role | Approval |
|---|---|
| Technical Lead | 🟢 |
| Cardano Head of Engineering | 🟢 |
| Cardano Head of Product | 🟢 |
| Test Engineer | 🟢 |
| Site Reliability Engineer | 🟢 |
Cardano DB Sync 13.6.0.1
This release is compatible with node-10.1.2 and supports the Chang#2 HF in mainnet. It also supports a new experimental optional feauture, where the address is separated from the tx_out table.
Upgrading from any 13.5.x.x db-sync instance requires a ledger state replay from genesis. This doesn't affect the database.
It is compatible with 13.6 and 13.5 snapshots. They can be found at:
| Network | Link to snapshot |
|---|---|
| Mainnet-13.6 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.6/ |
| Mainnet-13.5 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.5/ |
Changelog
https://github.com/IntersectMBO/cardano-db-sync/blob/13.6.0.1/CHANGELOG.md#13601
Documentation
Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash
Postgres setup
It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:
It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)
Notes
When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented here configuration.md
Platforms
- Linux 64-bit
- Docker
Requiresghc-8.10.xto build.
Known issues
Rollbacks take too long #1902
Sign off
| Role | Approval |
|---|---|
| Technical Lead | 🟢 |
| Cardano Head of Engineering | 🟢 |
| Cardano Head of Product | 🟢 |
| Test Engineer | 🟢 |
| Site Reliability Engineer | 🟢 |
13.6.0.0-pre
kderme
Kostas Dermentzis
This pre release is compatible with node 10.1.0-pre
It fixes issues and supports Chang+1 HF.
Changelog
Note that this node is not recommended for mainnet use. It should only be deployed on test environments such as SanchoNet and Preview.
Platforms
- Linux 64-bit
- Docker
Cardano DB Sync 13.5.0.2
This release fixes an issue with restarts, similar to node version 9.1.1. It is compatible with node version 9.1.1.
It is recommended that all users upgrade to db-sync version 13.5.0.2 when restarting their db-sync instance. It is also recommended to delete all ledger snapshots before upgrading.
The release also fixes an issue with flag --disable-cache not working properly and makes replaying from genesis faster, since it reduces redundant snapshots.
Upgrading
Upgrading from any 13.4.x.x or 13.5.x.x db-sync instance requires a ledger state replay from genesis. This doesn't affect the database. This is the final release that will support upgrading from pre-HF 13.x versions.
The release is compatible with 13.5, 13.4, 13.2 and 13.1 snapshots. They can be found at:
| Network | Link to snapshot |
|---|---|
| Mainnet-13.5 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.5/ |
| Mainnet-13.4 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.4/ |
| Mainnet-13.2 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.2/ |
| Mainnet-13.1 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.1/ |
Documentation
Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash
Postgres setup
It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:
It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)
Notes
When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented here configuration.md
Platforms
- Linux 64-bit
- Docker
Requiresghc-8.10.xto build.
Sign off
| Role | Approval |
|---|---|
| Technical Lead | 🟢 |
| Cardano Head of Engineering | 🟢 |
| Cardano Head of Product | 🟢 |
| Test Engineer | 🟢 |
| Site Reliability Engineer | 🟢 |
Cardano DB Sync 13.5.0.1
This release fixes an issue with restarts, similar to node version 9.1.1 fixes. It is compatible with 9.1.1.
It also fixes an issue with flag --disable-cache not working properly.
It is recommended that all users upgrade to db-sync version 13.5.0.1 when restarting their db-sync instance.
Upgrading
Upgrading from any 13.4.x.x 13.5.x.x release happens instantly.
Upgrading from other 13.x.x.x releases is also possible. A ledger state replay may be necessary from genesis. The existing db is not affected by this, only the ledger snapshot.
The release is compatible with 13.5, 13.4, 13.2 and 13.1 snapshots. They can be found at:
| Network | Link to snapshot |
|---|---|
| Mainnet-13.5 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.5/ |
| Mainnet-13.4 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.4/ |
| Mainnet-13.2 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.2/ |
| Mainnet-13.1 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.1/ |
Documentation
Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash
Postgres setup
It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:
It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)
Notes
When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented here configuration.md
Platforms
- Linux 64-bit
- Docker
Requiresghc-8.10.xto build.
Sign off
| Role | Approval |
|---|---|
| Technical Lead | 🟢 |
| Cardano Head of Engineering | 🟢 |
| Cardano Head of Product | |
| Test Engineer | 🟢 |
| Site Reliability Engineer |
Cardano DB Sync 13.5.0.0
This release fixes issue #1831, which could cause DB-Sync to crash under some unusual conditions
(while executing a rollback following an update to constitutional committee members).
It applies the following SQL code to the schema:
ALTER TABLE "committee_member" DROP CONSTRAINT "committee_member_committee_id_fkey";
ALTER TABLE "committee_member" ADD CONSTRAINT "committee_member_committee_id_fkey" FOREIGN KEY("committee_id") REFERENCES "committee"("id") ON DELETE CASCADE ON UPDATE RESTRICT;
Users can alternatively apply this fix manually to any 13.4.x.x release to avoid or to fix the issue. It is recommended that all
DB-Sync users either upgrade to version 13.5.0.0 or apply the fix manually.
Upgrading
Upgrading from any 13.4.x.x release happens instantly.
Upgrading from other 13.x.x.x releases is also possible. A ledger state replay may be necessary from genesis. The existing db is not affected by this, only the ledger snapshot.
If you restart db-sync with different genesis files, you need to initially delete the ledger state snapshots files.
The release is compatible with 13.4, 13.3, 13.2 and 13.1 snapshots. They can be found at:
| Network | Link to snapshot |
|---|---|
| Mainnet-13.5 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.5/ |
| Mainnet-13.4 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.4/ |
| Mainnet-13.2 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.2/ |
| Mainnet-13.1 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.1/ |
Documentation
Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash
Postgres setup
It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:
It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)
Notes
When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented here configuration.md
Platforms
- Linux 64-bit
- Docker
Requiresghc-8.10.xto build.
Non-default Changelog (this only affect users that use non default options)
- Fix
consumed_byoption for Byron inputs. A migration fixes old wrong values in place. 1821 - Fix only-utxo preset populating the metadata instead of the multiassets
Sign off
| Role | Approval |
|---|---|
| Technical Lead | 🟢 |
| Cardano Head of Engineering | 🟢 |
| Cardano Head of Product | 🟢 |
| Test Engineer | 🟢 |
| Site Reliability Engineer | 🟢 |
13.4.1.0
Cardano DB Sync 13.4.0.0
This release is compatible with Cardano node version 9.1.0. Newer node versions may also work, but this has not been tested.
The release is compatible with 13.4, 13.3 ,13.2 and 13.1 snapshots. They can be found at
| Network | Link to snapshot |
|---|---|
| Mainnet-13.4 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.4/ |
| Mainnet-13.2 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.2/ |
| Mainnet-13.1 | https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.1/ |
Older snapshots require migration, so it's recommended to use the latest version
Documentation for restoring from these files is available at state-snapshot.md.
Upgrade instructions
It is possible to upgrade to this release from previous versions.
A ledger state replay may be necessary from genesis. The existing db is not affected by this, only the ledger snapshot.
If you restart db-sync with different config or genesis files, you need to initially delete the ledger state snapshots files.
Documentation
Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash
Postgres setup
It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:
It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)
Notes
When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented here configuration.md
Platforms
- Linux 64-bit
- Docker
Requiresghc-8.10.xto build.
Changelog
The release mostly fixes issues to 13.3.0.0. Any schema changes are only minor.
Read more here
Known issues
- Using "only-utxo" preset has a bug: it enables the metadata instead of the multiassets. When using this flag, 13.4.0.1 tag should be used https://github.com/IntersectMBO/cardano-db-sync/releases/tag/13.4.0.1
- "pool_stats" preset will be renamed to "pool_stat" in next releases.
Sign off
| Role | Approval |
|---|---|
| Technical Lead | 🟢 |
| Cardano Head of Engineering | 🟢 |
| Cardano Head of Product | 🟢 |
| Test Engineer | 🟢 |
| Site Reliability Engineer | 🟢 |