Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.63 KB

README.md

File metadata and controls

42 lines (30 loc) · 1.63 KB

Example

Before starting

Please follow the the install procedure to ensure you're ready to get started. Before running CLI commands, you can take a look at its interface, either via the --help flag, or by reading this document.

Take a look!

This crate contains a fully working example of what a Cornucopia project can look like. There are a few queries and a schema defined for you in the queries/ folder and schema.sql file. Please bear in mind the used SQL is for demonstration purposes only. The Rust modules have already been generated in the src/cornucopia.rs file.

In src/main.rs you can see the queries in action, as you would use them in your own project. Seeing how the queries are used should give you a solid idea of what cornucopia is about, enough to get you started in your own project.

(Optional) Running the example

If you want to be able to run this example, you should

  • Have a reachable postgres database up-and-running (container or otherwise).
  • Modify the connection pool config (user, password, etc.) in main.rs so that it can connect to your database.
  • Load the schema
  • That's it! You should now be able to run the example.

Start experimenting

You can add or modify queries with your favorite SQL tool (no special command needed). When you're done modifying, rebuild the Rust modules for your SQL with cornucopia live. This will recreate the src/cornucopia.rs file.

Going deeper

If you want to know more, the project's readme explains pretty much everything there is to know about Cornucopia. The CLI's --help flag is also handy.