https://github.com/cornucopia-rs/cornucopia

Generate type-checked Rust from your PostgreSQL.
https://github.com/cornucopia-rs/cornucopia

database postgres postgresql rust sql

Last synced: 13 days ago
JSON representation

Generate type-checked Rust from your PostgreSQL.

• Host: GitHub
• URL: https://github.com/cornucopia-rs/cornucopia
• Owner: cornucopia-rs
• License: other
• Created: 2022-04-05T08:49:03.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-24T07:40:37.000Z (7 months ago)
• Last Synced: 2024-04-25T03:18:12.001Z (7 months ago)
• Topics: database, postgres, postgresql, rust, sql
• Language: Rust
• Homepage:
• Size: 1.63 MB
• Stars: 692
• Watchers: 7
• Forks: 30
• Open Issues: 48
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
  

Cornucopia



 

   Generate type-checked  Rust from your SQL

 








  

  

    

  

  

  

    

  


  

  

  

  

  

  

    

  

  

  

  

    

  

 

  


  

  

    

  

  

  

    

  





  


    

      Homepage

    

     | 

    

      Example

    

  






Cornucopia is a tool powered by [`rust-postgres`](https://github.com/sfackler/rust-postgres) designed to generate type-checked Rust interfaces from your PostgreSQL queries. It works by preparing your queries against an actual database and then running an extensive validation suite on them. Once the queries are prepared and validated, Rust code is generated into a module, which can be imported and used in your project. 

The basic premise is thus to:

1. Write your PostgreSQL queries.

2. Use Cornucopia to generate Rust code.

3. Use the generated code in your project.

Compared to other Rust database interfaces, Cornucopia's approach has the benefits of being simple to understand while also generating code that is both ergonomic and free of heavy macros or complex generics. Since Cornucopia generates plain Rust structs, you can also easily build upon the generated items.

Here are some defining features:

* SQL-first. Your SQL is the only source of truth. No intricate ORM.

* Powerful query validation. Catch errors before runtime, with powerful (and pretty) diagnostics.

* Supports custom user types (composites, domains, and enums) and one-dimensional arrays.

* Sync and async driver support, with optional pooling.

* Ergonomic non-allocating row mapping.

* Granular type nullity control.

* Available as a library and a CLI.

* As close to native `rust-postgres` performance as we can make it.

You can learn more about using Cornucopia by reading our [book](https://cornucopia-rs.netlify.app/book/index.html), or you can get a quickstart by looking at our [examples](https://cornucopia-rs.netlify.app/book/examples.html).

## A quick taste of Cornucopia

The [book](https://cornucopia-rs.netlify.app/book/index.html) is the place to go to get more in-depth explanations, but here is the simplest of tasters to give you an idea.

Let's say you have the following PostgreSQL queries

```sql

-- queries/some_query_file.sql

--! authors

SELECT first_name, last_name, country FROM Authors;

--! insert_author

INSERT INTO Authors(first_name, last_name, country) 

VALUES (:first_name, :last_name, :country)

```

Notice the query annotations (`--! authors`, `--! insert_authors`) and the named bind parameters (`:first_name`, etc.).

Then, after generating the Rust code with Cornucopia's CLI, you can import it into your project like so:

```rust

mod cornucopia;

use cornucopia::{authors, insert_author};

```

Finally here is an example usage of these queries:

```rust

insert_author.bind(&client, "Agatha", "Christie", "England");

let all_authors = authors().bind(&client).all();

for author in all_authors {

  println!("[{}] {}, {}", 

    author.country, 

    author.last_name.to_uppercase(), 

    author.first_name

  )

}

```

You can customize pretty much every aspect of your queries easily with Cornucopia (custom parameters and row structs, renaming, nullity control, etc.), so please head over to the [book](https://cornucopia-rs.netlify.app/book/index.html) if you're interested to learn more.

## MSRV

This crate uses Rust 2021 edition, which requires at least version 1.62.1.

## License

Licensed under either of

 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any

additional terms or conditions.