storj/cmd/statdb/README.md

# gRPC Server

This is a gRPC server which handles CRUD (create, read, update, delete) requests for storing stats for storagenodes in a relational database

To run the server:
```
go run cmd/pointerdb/main.go
```
You can also run using these flags: `-port=<port-number> -prod=<bool> -db=<db-name>`

You can then write a client program using the client library to access the Create, Get, Update, and UpdateBatch methods to create and interact with storagenode stat entries stored in the DB.
An example program utilizing these functions can be found at `storj.io/storj/examples/statdb-client/main.go`.

If changes are made to `storj.io/storj/pkg/statdb/proto/statdb.proto, the protobuf file will need to be regenerated by running `go generate` inside `pkg/statdb/proto`

If changes are made to `storj.io/storj/pkg/statdb/dbx/statdb.dbx, the dbx files will need to be regenerated by running `go generate` inside `pkg/statdb/dbx`
StatDB (#144) * add statdb proto and example client * server logic * update readme * remove boltdb from service.go * sqlite3 * add statdb server executable file * create statdb node table if it does not exist already * get UpdateBatch working * update based on jt review * remove some commented lines * fix linting issues * reformat * apiKey -> APIKey * update statdb client apiKey->APIKey 2018-07-27 22:11:44 +01:00			`# gRPC Server`

rename farmers to storagenode (#275) * rename farmers to storagenode * review changes * merge conflicts 2018-08-25 02:52:58 +01:00			`This is a gRPC server which handles CRUD (create, read, update, delete) requests for storing stats for storagenodes in a relational database`
StatDB (#144) * add statdb proto and example client * server logic * update readme * remove boltdb from service.go * sqlite3 * add statdb server executable file * create statdb node table if it does not exist already * get UpdateBatch working * update based on jt review * remove some commented lines * fix linting issues * reformat * apiKey -> APIKey * update statdb client apiKey->APIKey 2018-07-27 22:11:44 +01:00
			`To run the server:`
			```
			`go run cmd/pointerdb/main.go`
			```
			You can also run using these flags: `-port=<port-number> -prod=<bool> -db=<db-name>`

rename farmers to storagenode (#275) * rename farmers to storagenode * review changes * merge conflicts 2018-08-25 02:52:58 +01:00			`You can then write a client program using the client library to access the Create, Get, Update, and UpdateBatch methods to create and interact with storagenode stat entries stored in the DB.`
StatDB (#144) * add statdb proto and example client * server logic * update readme * remove boltdb from service.go * sqlite3 * add statdb server executable file * create statdb node table if it does not exist already * get UpdateBatch working * update based on jt review * remove some commented lines * fix linting issues * reformat * apiKey -> APIKey * update statdb client apiKey->APIKey 2018-07-27 22:11:44 +01:00			An example program utilizing these functions can be found at `storj.io/storj/examples/statdb-client/main.go`.

			If changes are made to `storj.io/storj/pkg/statdb/proto/statdb.proto, the protobuf file will need to be regenerated by running `go generate` inside `pkg/statdb/proto`

			If changes are made to `storj.io/storj/pkg/statdb/dbx/statdb.dbx, the dbx files will need to be regenerated by running `go generate` inside `pkg/statdb/dbx`