GOMODULES/goose
1
0
Fork 0
mirror of https://github.com/pressly/goose.git synced 2025-07-11 21:19:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
goose/blog/index.html

2046 lines
48 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="The missing goose docs.">
<link rel="canonical" href="https://pressly.github.io/goose/blog/">
<link rel="prev" href="../documentation/custom-store/">
<link rel="next" href="category/blog/">
<link rel="alternate" type="application/rss+xml" title="RSS feed" href="../feed_rss_created.xml">
<link rel="alternate" type="application/rss+xml" title="RSS feed of updated content" href="../feed_rss_updated.xml">
<link rel="icon" href="../assets/goose_logo_cropped.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.45+insiders-4.53.14">
<title>Blog - pressly/goose</title>
<link rel="stylesheet" href="../assets/stylesheets/main.12320a83.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../stylesheets/extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<meta property="og:type" content="website" />
<meta property="og:title" content="Blog - pressly/goose" />
<meta property="og:description" content="The missing goose docs." />
<meta property="og:image" content="https://pressly.github.io/goose/assets/images/social/blog/index.png" />
<meta property="og:image:type" content="image/png" />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />
<meta property="og:url" content="https://pressly.github.io/goose/blog/" />
<meta property="twitter:card" content="summary_large_image" />
<meta property="twitter:title" content="Blog - pressly/goose" />
<meta property="twitter:description" content="The missing goose docs." />
<meta property="twitter:image" content="https://pressly.github.io/goose/assets/images/social/blog/index.png" />
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="light-blue">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#blog" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="pressly/goose" class="md-header__button md-logo" aria-label="pressly/goose" data-md-component="logo">
<img src="../assets/goose_logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
pressly/goose
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Blog
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/pressly/goose" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
</div>
<div class="md-source__repository">
pressly/goose
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Getting Started
</a>
</li>
<li class="md-tabs__item">
<a href="../documentation/annotations/" class="md-tabs__link">
Documentation
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Blog
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="pressly/goose" class="md-nav__button md-logo" aria-label="pressly/goose" data-md-component="logo">
<img src="../assets/goose_logo.png" alt="logo">
</a>
pressly/goose
</label>
<div class="md-nav__source">
<a href="https://github.com/pressly/goose" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
</div>
<div class="md-source__repository">
pressly/goose
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
<div class="md-nav__link md-nav__container">
<a href=".." class="md-nav__link ">
<span class="md-ellipsis">
Getting Started
</span>
</a>
<label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Documentation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_1" >
<label class="md-nav__link" for="__nav_2_1" id="__nav_2_1_label" tabindex="0">
<span class="md-ellipsis">
Concepts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_1">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../documentation/annotations/" class="md-nav__link">
<span class="md-ellipsis">
SQL file annotations
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
<label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
<span class="md-ellipsis">
Library
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_2">
<span class="md-nav__icon md-icon"></span>
Library
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../documentation/provider/" class="md-nav__link">
<span class="md-ellipsis">
Goose provider
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
<label class="md-nav__link" for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
<span class="md-ellipsis">
CLI
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_3">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../documentation/cli-commands/" class="md-nav__link">
<span class="md-ellipsis">
Commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../documentation/environment-variables/" class="md-nav__link">
<span class="md-ellipsis">
Environment variables
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
<label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_4">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../documentation/custom-store/" class="md-nav__link">
<span class="md-ellipsis">
Custom store
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<div class="md-nav__link md-nav__container">
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Blog
</span>
</a>
<label class="md-nav__link md-nav__link--active" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Blog
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="">
<span class="md-ellipsis">
Archive
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2">
<span class="md-nav__icon md-icon"></span>
Archive
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="archive/2024/" class="md-nav__link">
<span class="md-ellipsis">
2024
</span>
</a>
</li>
<li class="md-nav__item">
<a href="archive/2023/" class="md-nav__link">
<span class="md-ellipsis">
2023
</span>
</a>
</li>
<li class="md-nav__item">
<a href="archive/2022/" class="md-nav__link">
<span class="md-ellipsis">
2022
</span>
</a>
</li>
<li class="md-nav__item">
<a href="archive/2021/" class="md-nav__link">
<span class="md-ellipsis">
2021
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_3" >
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="">
<span class="md-ellipsis">
Categories
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
Categories
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="category/blog/" class="md-nav__link">
<span class="md-ellipsis">
Blog
</span>
</a>
</li>
<li class="md-nav__item">
<a href="category/clickhouse/" class="md-nav__link">
<span class="md-ellipsis">
ClickHouse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="category/general/" class="md-nav__link">
<span class="md-ellipsis">
General
</span>
</a>
</li>
<li class="md-nav__item">
<a href="category/go-migrations/" class="md-nav__link">
<span class="md-ellipsis">
Go migrations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="category/package/" class="md-nav__link">
<span class="md-ellipsis">
Package
</span>
</a>
</li>
<li class="md-nav__item">
<a href="category/sql-migrations/" class="md-nav__link">
<span class="md-ellipsis">
SQL migrations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="category/testing/" class="md-nav__link">
<span class="md-ellipsis">
Testing
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<div class="md-content__inner">
<header class="md-typeset">
<h1 id="blog">Blog</h1>
</header>
<article class="md-post md-post--excerpt">
<header class="md-post__header">
<nav class="md-post__authors md-typeset">
<span class="md-author">
<img src="https://github.com/mfridman.png" alt="Mike Fridman">
</span>
</nav>
<div class="md-post__meta md-meta">
<ul class="md-meta__list">
<li class="md-meta__item">
<time datetime="2024-02-01 00:00:00+00:00">Feb 1, 2024</time></li>
<li class="md-meta__item">
in
<a href="category/blog/" class="md-meta__link">Blog</a></li>
</ul>
</div>
</header>
<div class="md-post__content md-typeset">
<h2 id="using-sqlc-and-goose"><a class="toclink" href="2024/goose-sqlc/">Using <code>sqlc</code> and <code>goose</code></a></h2>
<p>In this post, we give you a brief introduction to <code>sqlc</code> and show you how to use it with <code>goose</code>.</p>
<nav class="md-post__action">
<a href="2024/goose-sqlc/">
Continue reading
</a>
</nav>
</div>
</article>
<article class="md-post md-post--excerpt">
<header class="md-post__header">
<nav class="md-post__authors md-typeset">
<span class="md-author">
<img src="https://github.com/mfridman.png" alt="Mike Fridman">
</span>
</nav>
<div class="md-post__meta md-meta">
<ul class="md-meta__list">
<li class="md-meta__item">
<time datetime="2023-11-11 00:00:00+00:00">Nov 11, 2023</time></li>
<li class="md-meta__item">
in
<a href="category/blog/" class="md-meta__link">Blog</a>,
<a href="category/package/" class="md-meta__link">Package</a></li>
</ul>
</div>
</header>
<div class="md-post__content md-typeset">
<h2 id="adding-a-goose-provider"><a class="toclink" href="2023/goose-provider/">Adding a goose provider</a></h2>
<h3 id="introduction"><a class="toclink" href="2023/goose-provider/#introduction">Introduction</a></h3>
<p>In this post, we'll explore the new <code>Provider</code> feature recently added to the core goose package. If
you're new to goose, it's a tool for handling database migrations, available as a standalone CLI
tool and a package that can be used in Go applications.</p>
<p>Requires version <strong><a href="https://github.com/pressly/goose/releases/tag/v3.16.0">v3.16.0</a></strong> and above.</p>
<p>Adding a provider to your application is easy, here's a quick example:</p>
<div class="highlight"><pre><span></span><code><span class="nx">provider</span><span class="p">,</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">:=</span><span class="w"> </span><span class="nx">goose</span><span class="p">.</span><span class="nx">NewProvider</span><span class="p">(</span>
<span class="w"> </span><span class="nx">goose</span><span class="p">.</span><span class="nx">DialectPostgres</span><span class="p">,</span><span class="w"> </span><span class="c1">// (1)!</span>
<span class="w"> </span><span class="nx">db</span><span class="p">,</span><span class="w"> </span><span class="c1">// (2)!</span>
<span class="w"> </span><span class="nx">os</span><span class="p">.</span><span class="nx">DirFS</span><span class="p">(</span><span class="s">&quot;migrations&quot;</span><span class="p">),</span><span class="w"> </span><span class="c1">// (3)!</span>
<span class="p">)</span>
<span class="nx">results</span><span class="p">,</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">:=</span><span class="w"> </span><span class="nx">provider</span><span class="p">.</span><span class="nx">Up</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span><span class="w"> </span><span class="c1">// (4)!</span>
</code></pre></div>
<ol>
<li>
<p>The first argument is the dialect. It is the type of database technology you're using. In this
case, we're using Postgres. But goose also supports:</p>
<p>clickhouse, mssql, mysql, postgres, redshift, sqlite3, tidb, vertica, ydb,</p>
</li>
<li>
<p>The second argument is the database connection. You can use any database driver you want, as
long as it implements the <code>database/sql</code> interface.</p>
<p>A popular choice for Postgres is <a href="https://pkg.go.dev/github.com/jackc/pgx/v5">pgx/v5</a></p>
</li>
<li>
<p>The last argument may be <code>nil</code>. Why? Because goose also supports the ability to register Go
functions as migrations.</p>
<p>However, in most cases, you'll be using SQL migrations and reading them from disk. In this case,
you'll use <a href="https://pkg.go.dev/os#DirFS">os.DirFS</a> or embed them into your binary and use
<a href="https://pkg.go.dev/embed#FS">embed.FS</a>.</p>
</li>
<li>
<p>The last step is to invoke one of the migration methods. In this case, we're running the <code>Up</code>
method, which will run all the migrations that haven't been run yet. Here's a list of all the
methods:</p>
<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Provider</span><span class="p">)</span><span class="w"> </span><span class="nx">ApplyVersion</span>
<span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Provider</span><span class="p">)</span><span class="w"> </span><span class="nx">Close</span>
<span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Provider</span><span class="p">)</span><span class="w"> </span><span class="nx">Down</span>
<span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Provider</span><span class="p">)</span><span class="w"> </span><span class="nx">DownTo</span>
<span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Provider</span><span class="p">)</span><span class="w"> </span><span class="nx">GetDBVersion</span>
<span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Provider</span><span class="p">)</span><span class="w"> </span><span class="nx">ListSources</span>
<span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Provider</span><span class="p">)</span><span class="w"> </span><span class="nx">Ping</span>
<span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Provider</span><span class="p">)</span><span class="w"> </span><span class="nx">Status</span>
<span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Provider</span><span class="p">)</span><span class="w"> </span><span class="nx">Up</span>
<span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Provider</span><span class="p">)</span><span class="w"> </span><span class="nx">UpByOne</span>
<span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Provider</span><span class="p">)</span><span class="w"> </span><span class="nx">UpTo</span>
</code></pre></div>
</li>
</ol>
<nav class="md-post__action">
<a href="2023/goose-provider/">
Continue reading
</a>
</nav>
</div>
</article>
<article class="md-post md-post--excerpt">
<header class="md-post__header">
<nav class="md-post__authors md-typeset">
<span class="md-author">
<img src="https://github.com/mfridman.png" alt="Mike Fridman">
</span>
</nav>
<div class="md-post__meta md-meta">
<ul class="md-meta__list">
<li class="md-meta__item">
<time datetime="2022-12-30 00:00:00+00:00">Dec 30, 2022</time></li>
<li class="md-meta__item">
in
<a href="category/blog/" class="md-meta__link">Blog</a>,
<a href="category/sql-migrations/" class="md-meta__link">SQL migrations</a></li>
</ul>
</div>
</header>
<div class="md-post__content md-typeset">
<h2 id="sql-migration-files-and-goose-annotations"><a class="toclink" href="2022/overview-sql-file/">SQL migration files and goose annotations</a></h2>
<p>In this post we'll explore SQL migration files and <code>+goose</code> annotation comments, which are used to
parse SQL statements and optionally modify how migrations are executed.</p>
<p>As of this writing there are five annotations:</p>
<div class="highlight"><pre><span></span><code><span class="c1">-- +goose Up</span>
<span class="c1">-- +goose Down</span>
<span class="c1">-- +goose StatementBegin</span>
<span class="c1">-- +goose StatementEnd</span>
<span class="c1">-- +goose NO TRANSACTION</span>
</code></pre></div>
<nav class="md-post__action">
<a href="2022/overview-sql-file/">
Continue reading
</a>
</nav>
</div>
</article>
<article class="md-post md-post--excerpt">
<header class="md-post__header">
<nav class="md-post__authors md-typeset">
<span class="md-author">
<img src="https://github.com/mfridman.png" alt="Mike Fridman">
</span>
</nav>
<div class="md-post__meta md-meta">
<ul class="md-meta__list">
<li class="md-meta__item">
<time datetime="2022-06-19 00:00:00+00:00">Jun 19, 2022</time></li>
<li class="md-meta__item">
in
<a href="category/blog/" class="md-meta__link">Blog</a>,
<a href="category/clickhouse/" class="md-meta__link">ClickHouse</a></li>
</ul>
</div>
</header>
<div class="md-post__content md-typeset">
<h2 id="improving-clickhouse-support"><a class="toclink" href="2022/improving-clickhouse/">Improving ClickHouse support</a></h2>
<p><a href="https://clickhouse.com/">ClickHouse</a> is a an open-source column-oriented database that is
well-suited for analytical workloads. Over the past few years we've seen more and more demand for
improved ClickHouse support in goose.</p>
<p>To summarize:</p>
<ul>
<li>Upgraded to the latest <code>/v2</code> driver:
<a href="https://github.com/ClickHouse/clickhouse-go">ClickHouse/clickhouse-go</a></li>
<li>Full end-end tests against the docker image:
<a href="https://hub.docker.com/r/clickhouse/clickhouse-server/">clickhouse/clickhouse-server</a></li>
<li>Bug fixes and improvements</li>
</ul>
<div class="admonition danger">
<p>The <code>/v2</code> driver <a href="https://github.com/ClickHouse/clickhouse-go/issues/525">changed the DSN format</a>, so be prepared for a breaking change. This is actually a good thing, because it brings the format in-line with other databases.</p>
</div>
<nav class="md-post__action">
<a href="2022/improving-clickhouse/">
Continue reading
</a>
</nav>
</div>
</article>
<article class="md-post md-post--excerpt">
<header class="md-post__header">
<nav class="md-post__authors md-typeset">
<span class="md-author">
<img src="https://github.com/mfridman.png" alt="Mike Fridman">
</span>
</nav>
<div class="md-post__meta md-meta">
<ul class="md-meta__list">
<li class="md-meta__item">
<time datetime="2021-12-19 00:00:00+00:00">Dec 19, 2021</time></li>
<li class="md-meta__item">
in
<a href="category/blog/" class="md-meta__link">Blog</a>,
<a href="category/general/" class="md-meta__link">General</a></li>
</ul>
</div>
</header>
<div class="md-post__content md-typeset">
<h2 id="ad-hoc-migrations-with-no-versioning"><a class="toclink" href="2021/no-version-migrations/">Ad-hoc migrations with no versioning</a></h2>
<p>This post describes a new feature recently added to <code>goose</code> -- the ability to apply migrations with
<strong>no versioning</strong>. A common use case is to seed a database with data <em>after</em> versioned migrations
have been applied.</p>
<nav class="md-post__action">
<a href="2021/no-version-migrations/">
Continue reading
</a>
</nav>
</div>
</article>
<article class="md-post md-post--excerpt">
<header class="md-post__header">
<nav class="md-post__authors md-typeset">
<span class="md-author">
<img src="https://github.com/mfridman.png" alt="Mike Fridman">
</span>
</nav>
<div class="md-post__meta md-meta">
<ul class="md-meta__list">
<li class="md-meta__item">
<time datetime="2021-12-19 00:00:00+00:00">Dec 19, 2021</time></li>
<li class="md-meta__item">
in
<a href="category/blog/" class="md-meta__link">Blog</a>,
<a href="category/general/" class="md-meta__link">General</a></li>
</ul>
</div>
</header>
<div class="md-post__content md-typeset">
<h2 id="a-tour-of-goose-up-and-down-commands"><a class="toclink" href="2021/visualizing-up-down-commands/">A tour of goose up and down commands</a></h2>
<p>A while ago a co-op student, who happened to be a visual leaner, asked if it were possible to
explain <code>goose</code> commands visually. At the time we were still at an office, so we gathered around the
whiteboard and doodled some diagrams.</p>
<p>This post captures some of those whiteboard sketches, which seemed to help.</p>
<nav class="md-post__action">
<a href="2021/visualizing-up-down-commands/">
Continue reading
</a>
</nav>
</div>
</article>
<article class="md-post md-post--excerpt">
<header class="md-post__header">
<nav class="md-post__authors md-typeset">
<span class="md-author">
<img src="https://github.com/mfridman.png" alt="Mike Fridman">
</span>
</nav>
<div class="md-post__meta md-meta">
<ul class="md-meta__list">
<li class="md-meta__item">
<time datetime="2021-10-16 00:00:00+00:00">Oct 16, 2021</time></li>
<li class="md-meta__item">
in
<a href="category/blog/" class="md-meta__link">Blog</a>,
<a href="category/general/" class="md-meta__link">General</a></li>
</ul>
</div>
</header>
<div class="md-post__content md-typeset">
<h2 id="adding-support-for-out-of-order-migrations"><a class="toclink" href="2021/out-of-order-migrations/">Adding support for out-of-order migrations</a></h2>
<p>Starting with <code>goose</code> <a href="https://github.com/pressly/goose/releases/tag/v3.3.0">v3.3.0</a> we added the
ability to apply missing (out-of-order) migrations. Thanks for all the the community feedback over
the years.</p>
<nav class="md-post__action">
<a href="2021/out-of-order-migrations/">
Continue reading
</a>
</nav>
</div>
</article>
<article class="md-post md-post--excerpt">
<header class="md-post__header">
<nav class="md-post__authors md-typeset">
<span class="md-author">
<img src="https://github.com/mfridman.png" alt="Mike Fridman">
</span>
</nav>
<div class="md-post__meta md-meta">
<ul class="md-meta__list">
<li class="md-meta__item">
<time datetime="2021-09-17 00:00:00+00:00">Sep 17, 2021</time></li>
<li class="md-meta__item">
in
<a href="category/blog/" class="md-meta__link">Blog</a>,
<a href="category/testing/" class="md-meta__link">Testing</a></li>
</ul>
</div>
</header>
<div class="md-post__content md-typeset">
<h2 id="better-tests-with-containers"><a class="toclink" href="2021/better-tests/">Better tests with containers</a></h2>
<p>Managing state is hard. Managing database state is even harder. And coordinating state within a test
suite is just always a bad time.</p>
<p>But it doesn't have to be this way!</p>
<p>There is a fantastic Go package called <a href="https://github.com/ory/dockertest">ory/dockertest</a> that
allows you to spin up ephemeral docker containers. It'll work both locally (assuming you have Docker
installed) and in your Continuous Integration (CI) pipelines.</p>
<nav class="md-post__action">
<a href="2021/better-tests/">
Continue reading
</a>
</nav>
</div>
</article>
<article class="md-post md-post--excerpt">
<header class="md-post__header">
<nav class="md-post__authors md-typeset">
<span class="md-author">
<img src="https://github.com/mfridman.png" alt="Mike Fridman">
</span>
</nav>
<div class="md-post__meta md-meta">
<ul class="md-meta__list">
<li class="md-meta__item">
<time datetime="2021-08-21 00:00:00+00:00">Aug 21, 2021</time></li>
<li class="md-meta__item">
in
<a href="category/blog/" class="md-meta__link">Blog</a>,
<a href="category/go-migrations/" class="md-meta__link">Go migrations</a></li>
</ul>
</div>
</header>
<div class="md-post__content md-typeset">
<h2 id="embedding-migrations"><a class="toclink" href="2021/embed-sql-migrations/">Embedding migrations</a></h2>
<h3 id="embedding-migrations_1"><a class="toclink" href="2021/embed-sql-migrations/#embedding-migrations_1">Embedding migrations</a></h3>
<p>Go continues to be boring while sprinkling quality of life features. One of the recent additions was
the ability to embed files at compile time. Click here for
<a href="https://golang.org/doc/go1.16#library-embed">go1.16 release notes</a>.</p>
<p>Sine many users compile <code>goose</code> themselves, this new embed feature paves the way for embedding SQL
files directly into the <code>goose</code> binary. This was <em>already</em> possible with existing tools, however,
now that embedding is part of the standard library it's never been easier to offer this feature.</p>
<nav class="md-post__action">
<a href="2021/embed-sql-migrations/">
Continue reading
</a>
</nav>
</div>
</article>
<article class="md-post md-post--excerpt">
<header class="md-post__header">
<nav class="md-post__authors md-typeset">
<span class="md-author">
<img src="https://github.com/mfridman.png" alt="Mike Fridman">
</span>
</nav>
<div class="md-post__meta md-meta">
<ul class="md-meta__list">
<li class="md-meta__item">
<time datetime="2021-07-01 00:00:00+00:00">Jul 1, 2021</time></li>
<li class="md-meta__item">
in
<a href="category/blog/" class="md-meta__link">Blog</a></li>
</ul>
</div>
</header>
<div class="md-post__content md-typeset">
<h2 id="hello-docs"><a class="toclink" href="2021/welcome/">Hello, docs!</a></h2>
<p>Introductory blog post. I guess I'll write a few words.</p>
<nav class="md-post__action">
<a href="2021/welcome/">
Continue reading
</a>
</nav>
</div>
</article>
<nav class="md-pagination">
</nav>
</div>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs Insiders
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.tracking", "navigation.sections", "navigation.expand", "navigation.tabs", "navigation.indexes", "navigation.top", "content.code.annotate", "content.code.copy"], "search": "../assets/javascripts/workers/search.c7c1ca2c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.203fd0bc.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink