README fix some formatting
This commit is contained in:
Patrick O'brien
parent
ec4b7163c2
commit
82e55df5bb
30
README.md
30
README.md
|
|
@ -16,12 +16,9 @@ lifecycle.
|
||||||
## Why?
|
## Why?
|
||||||
Well...
|
Well...
|
||||||
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## About SQL Boiler
|
## About SQL Boiler
|
||||||
|
|
||||||
#### Features
|
### Features
|
||||||
|
|
||||||
- Full model generation
|
- Full model generation
|
||||||
- High performance through generation
|
- High performance through generation
|
||||||
|
|
@ -38,15 +35,15 @@ Well...
|
||||||
- Compatibility tests (Run against your own DB schema)
|
- Compatibility tests (Run against your own DB schema)
|
||||||
- Debug logging
|
- Debug logging
|
||||||
|
|
||||||
#### Supported Databases
|
### Supported Databases
|
||||||
|
|
||||||
- PostgreSQL
|
- PostgreSQL
|
||||||
|
|
||||||
**Note:** Seeking contributors for other database engines.
|
*Note: Seeking contributors for other database engines.*
|
||||||
|
|
||||||
#### Small Taste
|
### A Small Taste
|
||||||
|
|
||||||
For a comprehensive list of available operations and examples please see [Features & Examples](#features-examples).
|
For a comprehensive list of available operations and examples please see [Features & Examples](#features--examples).
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import (
|
import (
|
||||||
|
|
@ -105,8 +102,6 @@ if err != nil {
|
||||||
fmt.Println(len(users.R.FavoriteMovies))
|
fmt.Println(len(users.R.FavoriteMovies))
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Requirements & Pro Tips
|
## Requirements & Pro Tips
|
||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
|
|
@ -127,8 +122,6 @@ fmt.Println(len(users.R.FavoriteMovies))
|
||||||
* If you never plan on using the hooks functionality you can disable generation of this
|
* If you never plan on using the hooks functionality you can disable generation of this
|
||||||
feature using the `--no-hooks` flag. This will save you some binary size.
|
feature using the `--no-hooks` flag. This will save you some binary size.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
#### Download
|
#### Download
|
||||||
|
|
@ -174,7 +167,7 @@ not to pass them through the command line or environment variables:
|
||||||
| out_folder| "models" |
|
| out_folder| "models" |
|
||||||
| exclude | [ ] |
|
| exclude | [ ] |
|
||||||
|
|
||||||
**Example:**
|
Example:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[postgres]
|
[postgres]
|
||||||
|
|
@ -185,7 +178,6 @@ user="dbusername"
|
||||||
pass="dbpassword"
|
pass="dbpassword"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
#### Initial Generation
|
#### Initial Generation
|
||||||
|
|
||||||
After creating a configuration file that points at the database we want to
|
After creating a configuration file that points at the database we want to
|
||||||
|
|
@ -226,8 +218,6 @@ go test ./models # This requires an administrator postgres user because of some
|
||||||
# voodoo we do to disable triggers for the generated test db
|
# voodoo we do to disable triggers for the generated test db
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Diagnosing Problems
|
## Diagnosing Problems
|
||||||
|
|
||||||
The most common causes of problems and panics are:
|
The most common causes of problems and panics are:
|
||||||
|
|
@ -246,8 +236,6 @@ Setting `boil.DebugMode` to `true` can help with this. You can change the output
|
||||||
|
|
||||||
If you're still stuck and/or you think you've found a bug, feel free to leave an issue and we'll do our best to help you.
|
If you're still stuck and/or you think you've found a bug, feel free to leave an issue and we'll do our best to help you.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Features & Examples
|
## Features & Examples
|
||||||
|
|
||||||
### Function Variations
|
### Function Variations
|
||||||
|
|
@ -259,7 +247,7 @@ names `created_at` or `updated_at` it will automatically set them
|
||||||
to `time.Now()` in your database, and update your object appropriately.
|
to `time.Now()` in your database, and update your object appropriately.
|
||||||
To disable this feature use `--no-auto-timestamps`.
|
To disable this feature use `--no-auto-timestamps`.
|
||||||
|
|
||||||
**Note:** You can set the timezone for this feature by calling `boil.SetLocation()`
|
Note: You can set the timezone for this feature by calling `boil.SetLocation()`
|
||||||
|
|
||||||
#### Overriding Automatic Timestamps
|
#### Overriding Automatic Timestamps
|
||||||
|
|
||||||
|
|
@ -312,12 +300,8 @@ relationships to one and to many
|
||||||
relationship set ops (to one: set, remove, tomany: add, set, remove)
|
relationship set ops (to one: set, remove, tomany: add, set, remove)
|
||||||
eager loading (nested and flat)
|
eager loading (nested and flat)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Benchmarks
|
## Benchmarks
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
### Won't compiling models for a huge database be very slow?
|
### Won't compiling models for a huge database be very slow?
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue