Uploaded image for project: 'Zapped: AcousticBrainz'
  1. Zapped: AcousticBrainz
  2. AB-364

Create developer documentation for dumps

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • Server
    • None

      I'd like us to create some documentation which explains how the dumps work, and how to extend them. This could be in a DEVELOPERS.md file in the root directory. It should include things like:

      • Overview of dumps and what different types of dumps are created (public DB, private DB LL-json, HL-json)
      • How to add a new table to the dump (increase schema if needed, where to add table definition, update sequences)
      • Difference between incremental and full dumps
      • When to make a full dump (If schema number has changed, in HL if model definitions have changed)
      • How to do an import
      • How to make a dump and do an import of a small subset for development purposes

            Unassigned Unassigned
            alastairp Alastair Porter
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:

                Version Package