https://github.com/fabianlindfors/reshape-helper

A Rust helper library for applications using Reshape
https://github.com/fabianlindfors/reshape-helper

Last synced: 21 days ago
JSON representation

A Rust helper library for applications using Reshape

• Host: GitHub
• URL: https://github.com/fabianlindfors/reshape-helper
• Owner: fabianlindfors
• License: mit
• Created: 2022-04-19T17:28:34.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-03T14:02:21.000Z (over 2 years ago)
• Last Synced: 2024-11-17T09:47:32.831Z (about 1 month ago)
• Language: Rust
• Size: 9.77 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Reshape Rust helper

[![Test status badge](https://github.com/fabianlindfors/reshape-helper/actions/workflows/test.yaml/badge.svg)](https://github.com/fabianlindfors/reshape-helper/actions/workflows/test.yaml)

This is a Rust helper library for the automated, zero-downtime schema migration tool [Reshape](https://github.com/fabianlindfors/reshape). To achieve zero-downtime migrations, Reshape requires that your application runs a simple query when it opens a connection to the database to select the right schema. This library automates that process and provides a macro to embed the right query directly in your application.

## Installation

Add `reshape_helper` as a dependency to your `Cargo.toml`:

```toml

[dependencies]

reshape_helper = "0.1.1"

```

## Usage

The library exposes a single macro which will find all your Reshape migration files and determine the right schema query to run. The macro will be evaluated at compile time and the query embedded directly in your binary, so you won't need to keep your migration files around at runtime.

The following is an example of how to use the library together with [SQLx](https://github.com/launchbadge/sqlx) (but it works with any Postgres client):

```rust

use reshape_helper::schema_query

use sqlx::postgres::PgPoolOptions;

#[async_std::main]

async fn main() {

	let reshape_schema_query = schema_query!();

	let pool = PgPoolOptions::new()

		.after_connect(|conn| Box::pin(async move {

			conn.execute(reshape_schema_query).await?;

			Ok(())

		}))

		.connect("postgres://postgres@localhost:5432/db").await?;

}

```

By default, `schema_query!` will look for migration files in `migrations/` but you can specify your own directories as well:

```rust

use reshape_helper::schema_query

fn main() {

	let reshape_schema_query = schema_query!(

		"src/users/migrations",

		"src/todos/migrations",

	);

	// Execute reshape_schema_query against your database...

}

```

## License

Released under the [MIT license](https://choosealicense.com/licenses/mit/).