gotosocial/internal/db/bundb/migrations
Daenney 5e2bf0bdca
[chore] Improve copyright header handling (#1608)
* [chore] Remove years from all license headers

Years or year ranges aren't required in license headers. Many projects
have removed them in recent years and it avoids a bit of yearly toil.

In many cases our copyright claim was also a bit dodgy since we added
the 2021-2023 header to files created after 2021 but you can't claim
copyright into the past that way.

* [chore] Add license header check

This ensures a license header is always added to any new file. This
avoids maintainers/reviewers needing to remember to check for and ask
for it in case a contribution doesn't include it.

* [chore] Add missing license headers

* [chore] Further updates to license header

* Use the more common // indentend comment format
* Remove the hack we had for the linter now that we use the // format
* Add SPDX license identifier
2023-03-12 16:00:57 +01:00
..
20211113114307_init [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220214175650_media_cleanup [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220315160814_admin_account_actions [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220905150505_custom_emoji_updates [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20211113114307_init.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220214175650_media_cleanup.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220305130328_database_optimizations.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220315160814_admin_account_actions.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220502113806_add_missing_indexes.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220506110822_add_account_raw_note.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220511165212_add_account_raw_note_fix.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220518123621_additional_indexing.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220612091800_duplicated_media_cleanup.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220710153020_fix_slow_web_profile_queries.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220804120132_account_default_post_format.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220823140228_user_custom_css.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220827085121_assign_missing_in_reply_to_uris.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220830014732_regenerate_indexes_for_follows.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220903141016_store_gifs_as_image.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220905150505_custom_emoji_updates.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220916122701_emojis_in_accounts.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220922142408_shared_inbox_delivery.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20220926115233_indexes.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20221006114842_add_rss_functionality.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20221011125732_refetch_updated_emojis.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20221031145649_emoji_categories.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20221103203553_add_external_id.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20221108142419_create_account_tombstones.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20221220134514_mp4_jiggery_pokery.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20230105171144_report_model.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20230126170719_format_to_content_type.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20230202212700_rename_account_webfingered_to_fetched.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
20230221150957_status_pin_client_api.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
main.go [chore] Improve copyright header handling (#1608) 2023-03-12 16:00:57 +01:00
README.md [chore] Update/add license headers for 2023 (#1304) 2023-01-05 12:43:00 +01:00

Migrations

How do I write a migration file?

See here

As a template, take one of the existing migration files and modify it, or use the below code snippet:

/*
   GoToSocial
   Copyright (C) 2021-2023 GoToSocial Authors admin@gotosocial.org

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package migrations

import (
    "context"

    "github.com/uptrace/bun"
)

func init() {
    up := func(ctx context.Context, db *bun.DB) error {
        return db.RunInTx(ctx, nil, func(ctx context.Context, tx bun.Tx) error {
            // your logic here
            return nil
        })
    }

    down := func(ctx context.Context, db *bun.DB) error {
        return db.RunInTx(ctx, nil, func(ctx context.Context, tx bun.Tx) error {
            // your logic here
            return nil
        })
    }

    if err := Migrations.Register(up, down); err != nil {
        panic(err)
    }
}

File format

Bun requires a very specific format: 14 digits, then letters or underscores.

You can use the following bash command on your branch to generate a suitable migration filename.

echo "$(date --utc +%Y%m%d%H%M%S | head -c 14)_$(git rev-parse --abbrev-ref HEAD).go"

Rules of thumb

  1. DON'T DROP TABLES!!!!!!!!
  2. Don't make something NOT NULL if it's likely to already contain null fields.