mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-14 07:26:47 +00:00
b949388994
* Add exchange manager to engine
* Several improvements for engine and friends
1) New file.Exists func
2) gRPC TLS cert expiration date check and regeneration
3) New donation var for use across the codebase
4) Use Go log package until the logger is initialised
* Add cert tests and create dir tree if it doesn't exist for file.Write
* Link up donation address to documentation tool plus minor adjustments
* Fix remaining donation addrs
* Move non-needed reload exchange funcs
* Revert accidental config_example.json changes 🕯️
* Use go logger for logging until the logger has initiliased, otherwise no output will be seen
* Link up portfolio delay val and other fixes
* Run go mod tidy after dependabot PR
* Address nitterinos
166 lines
5.8 KiB
Markdown
166 lines
5.8 KiB
Markdown
# GoCryptoTrader package Database
|
|
|
|
<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70">
|
|
|
|
|
|
[](https://travis-ci.org/thrasher-corp/gocryptotrader)
|
|
[](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
|
|
[](https://godoc.org/github.com/thrasher-corp/gocryptotrader/portfolio)
|
|
[](http://codecov.io/github/thrasher-corp/gocryptotrader?branch=master)
|
|
[](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
|
|
|
|
|
|
This database package is part of the GoCryptoTrader codebase.
|
|
|
|
## This is still in active development
|
|
|
|
You can track ideas, planned features and what's in progress on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader).
|
|
|
|
Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://join.slack.com/t/gocryptotrader/shared_invite/enQtNTQ5NDAxMjA2Mjc5LTc5ZDE1ZTNiOGM3ZGMyMmY1NTAxYWZhODE0MWM5N2JlZDk1NDU0YTViYzk4NTk3OTRiMDQzNGQ1YTc4YmRlMTk)
|
|
|
|
## Current Features for database package
|
|
|
|
+ Establishes & Maintains database connection across program life cycle
|
|
+ Migration handed by [Goose](https://github.com/thrasher-corp/goose)
|
|
+ Model generation handled by [SQLBoiler](https://github.com/thrasher-corp/sqlboiler)
|
|
|
|
## How to use
|
|
|
|
##### Prerequisites
|
|
|
|
[SQLBoiler](https://github.com/thrasher-corp/sqlboiler)
|
|
```shell script
|
|
go get -u github.com/thrasher-corp/sqlboiler
|
|
```
|
|
|
|
[Postgres Driver](https://github.com/thrasher-corp/sqlboiler/drivers/sqlboiler-psql)
|
|
```shell script
|
|
go get -u github.com/thrasher-corp/sqlboiler/drivers/sqlboiler-psql
|
|
```
|
|
|
|
[SQLite Driver](https://github.com/thrasher-corp/sqlboiler-sqlite3)
|
|
```shell script
|
|
go get -u github.com/thrasher-corp/sqlboiler-sqlite3
|
|
```
|
|
|
|
##### Configuration
|
|
|
|
The database configuration struct is currently:
|
|
```shell script
|
|
type Config struct {
|
|
Enabled bool `json:"enabled"`
|
|
Verbose bool `json:"verbose"`
|
|
Driver string `json:"driver"`
|
|
drivers.ConnectionDetails `json:"connectionDetails"`
|
|
}
|
|
```
|
|
And Connection Details:
|
|
```sh
|
|
type ConnectionDetails struct {
|
|
Host string `json:"host"`
|
|
Port uint16 `json:"port"`
|
|
Username string `json:"username"`
|
|
Password string `json:"password"`
|
|
Database string `json:"database"`
|
|
SSLMode string `json:"sslmode"`
|
|
}
|
|
```
|
|
|
|
With an example configuration being:
|
|
|
|
```sh
|
|
"database": {
|
|
"enabled": true,
|
|
"verbose": true,
|
|
"driver": "postgres",
|
|
"connectionDetails": {
|
|
"host": "localhost",
|
|
"port": 5432,
|
|
"username": "gct-dev",
|
|
"password": "gct-dev",
|
|
"database": "gct-dev",
|
|
"sslmode": "disable"
|
|
}
|
|
},
|
|
```
|
|
|
|
##### Create and Run migrations
|
|
Migrations are created using a modified version of [Goose](https://github.com/thrasher-corp/goose)
|
|
|
|
A helper tool sits in the ./cmd/dbmigrate folder that includes the following features:
|
|
|
|
+ Check current database version with the "status" command
|
|
```shell script
|
|
dbmigrate -command status
|
|
```
|
|
|
|
+ Create a new migration
|
|
```sh
|
|
dbmigrate -command "create" -args "model"
|
|
```
|
|
_This will create a folder in the ./database/migration folder that contains postgres.sql and sqlite.sql files_
|
|
+ Run dbmigrate command with -command up
|
|
```shell script
|
|
dbmigrate -command "up"
|
|
```
|
|
|
|
dbmigrate provides a -migrationdir flag override to tell it what path to look in for migrations
|
|
|
|
##### Adding a new model
|
|
Model's are generated using [SQLBoiler](https://github.com/thrasher-corp/sqlboiler)
|
|
A helper tool has been made located in gen_sqlboiler_config that will parse your GoCryptoTrader config and output a SQLBoiler config
|
|
|
|
```sh
|
|
gen_sqlboiler_config
|
|
```
|
|
|
|
By default this will look in your gocryptotrader data folder and default config, these can be overwritten
|
|
along with the location of the sqlboiler generated config
|
|
|
|
```shell script
|
|
-config "configname.json"
|
|
-datadir "~/.gocryptotrader/"
|
|
-outdir "~/.gocryptotrader/"
|
|
```
|
|
|
|
|
|
Generate a new model that gets placed in ./database/models/<databasetype> folder
|
|
|
|
Linux:
|
|
```shell script
|
|
sqlboiler -o database/models/postgres -p postgres --no-auto-timestamps --wipe psql
|
|
```
|
|
Windows:
|
|
```sh
|
|
sqlboiler -o database\\models\\postgres -p postgres --no-auto-timestamps --wipe psql
|
|
```
|
|
|
|
Helpers have been provided in the Makefile for linux users
|
|
```
|
|
make gen_db_models
|
|
```
|
|
And in the contrib/sqlboiler.cmd for windows users
|
|
|
|
##### Adding a Repository
|
|
+ Create Repository directory in github.com/thrasher-corp/gocryptotrader/database/repository/
|
|
|
|
## Contribution
|
|
|
|
Please feel free to submit any pull requests or suggest any desired features to be added.
|
|
|
|
When submitting a PR, please abide by our coding guidelines:
|
|
|
|
+ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
|
|
+ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
|
|
+ Code must adhere to our [coding style](https://github.com/thrasher-corp/gocryptotrader/blob/master/doc/coding_style.md).
|
|
+ Pull requests need to be based on and opened against the `master` branch.
|
|
|
|
## Donations
|
|
|
|
<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/donate.png?raw=true" hspace="70">
|
|
|
|
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
|
|
|
|
***bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc***
|
|
|