storj/examples/pointerdb-client/README.md

# gRPC Client + BoltDB Crud Interface

This is an example gRPC client which makes CRUD requests (create, read, update, delete) for storing pointers at given paths in BoltDB.

The gRPC server at `storj.io/storj/cmd/pointerdb/main.go` needs to be running for this to work.

To run the client:
```
go run examples/pointerdb-client/main.go
```
You can change the port number with a flag if necessary: `-port=<port-number>`

Afterward, you can use [Bolter](https://github.com/hasit/bolter) or a similar BoltDB viewer to make sure your pointer entries were changed as expected.

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

Tests for this example code can be found in `storj.io/storj/pkg/pointerdb/client_test.go`.
adding grpc interface to network state (#33) * adds proto files for netstate crud * moves netstate grpc client lib into pkg/netstate where grpc netstate service is defined * starts adding grpc client and server tests * moves creation of grpc server into cmd/netstate/main.go, removes pkg/netstate/service.go, adds more client testing * changed all 'Path' and 'Value' fields from strings to bytes, updated tests * changes Get and Delete in proto file to receive 'requests' instead of 'file paths', adds tests for Get, List, and Delete * changes netstate-routes to get 'fileValue' bytes not 'fileInfo' * adds example rpc client in 'examples' and adds more specific debug logs * adds readmes for netstate rpc services and updates netstate-routes 2018-05-15 01:31:26 +01:00			`# gRPC Client + BoltDB Crud Interface`

Enables netstate service to save pointers (#49) * adds pointer to netstate proto file * generated updated netstate proto * changes boltdb netstate to save pointers as values * updates netstate Put to save Pointers, updates client example to put a pointer, adds grpc status errors, updates tests, changes boltdb 'File' struct to 'PointerEntry' * updates netstate client example and client test to save pointers, updates netstate List and Delete * begins adding netstate-http tests * removes netstate http service * re-adds netstate auth * updates boltdb netstate test * changes encrypted_unencrypted_size from int64 to bytes in netstate proto * updates READMEs 2018-05-30 03:47:40 +01:00			`This is an example gRPC client which makes CRUD requests (create, read, update, delete) for storing pointers at given paths in BoltDB.`
adding grpc interface to network state (#33) * adds proto files for netstate crud * moves netstate grpc client lib into pkg/netstate where grpc netstate service is defined * starts adding grpc client and server tests * moves creation of grpc server into cmd/netstate/main.go, removes pkg/netstate/service.go, adds more client testing * changed all 'Path' and 'Value' fields from strings to bytes, updated tests * changes Get and Delete in proto file to receive 'requests' instead of 'file paths', adds tests for Get, List, and Delete * changes netstate-routes to get 'fileValue' bytes not 'fileInfo' * adds example rpc client in 'examples' and adds more specific debug logs * adds readmes for netstate rpc services and updates netstate-routes 2018-05-15 01:31:26 +01:00
rename netstate to pointerdb (#127) * rename netstate to pointerdb 2018-07-06 20:43:53 +01:00			The gRPC server at `storj.io/storj/cmd/pointerdb/main.go` needs to be running for this to work.
adding grpc interface to network state (#33) * adds proto files for netstate crud * moves netstate grpc client lib into pkg/netstate where grpc netstate service is defined * starts adding grpc client and server tests * moves creation of grpc server into cmd/netstate/main.go, removes pkg/netstate/service.go, adds more client testing * changed all 'Path' and 'Value' fields from strings to bytes, updated tests * changes Get and Delete in proto file to receive 'requests' instead of 'file paths', adds tests for Get, List, and Delete * changes netstate-routes to get 'fileValue' bytes not 'fileInfo' * adds example rpc client in 'examples' and adds more specific debug logs * adds readmes for netstate rpc services and updates netstate-routes 2018-05-15 01:31:26 +01:00
			`To run the client:`
			```
rename netstate to pointerdb (#127) * rename netstate to pointerdb 2018-07-06 20:43:53 +01:00			`go run examples/pointerdb-client/main.go`
adding grpc interface to network state (#33) * adds proto files for netstate crud * moves netstate grpc client lib into pkg/netstate where grpc netstate service is defined * starts adding grpc client and server tests * moves creation of grpc server into cmd/netstate/main.go, removes pkg/netstate/service.go, adds more client testing * changed all 'Path' and 'Value' fields from strings to bytes, updated tests * changes Get and Delete in proto file to receive 'requests' instead of 'file paths', adds tests for Get, List, and Delete * changes netstate-routes to get 'fileValue' bytes not 'fileInfo' * adds example rpc client in 'examples' and adds more specific debug logs * adds readmes for netstate rpc services and updates netstate-routes 2018-05-15 01:31:26 +01:00			```
			You can change the port number with a flag if necessary: `-port=<port-number>`

Enables netstate service to save pointers (#49) * adds pointer to netstate proto file * generated updated netstate proto * changes boltdb netstate to save pointers as values * updates netstate Put to save Pointers, updates client example to put a pointer, adds grpc status errors, updates tests, changes boltdb 'File' struct to 'PointerEntry' * updates netstate client example and client test to save pointers, updates netstate List and Delete * begins adding netstate-http tests * removes netstate http service * re-adds netstate auth * updates boltdb netstate test * changes encrypted_unencrypted_size from int64 to bytes in netstate proto * updates READMEs 2018-05-30 03:47:40 +01:00			`Afterward, you can use [Bolter](https://github.com/hasit/bolter) or a similar BoltDB viewer to make sure your pointer entries were changed as expected.`
adding grpc interface to network state (#33) * adds proto files for netstate crud * moves netstate grpc client lib into pkg/netstate where grpc netstate service is defined * starts adding grpc client and server tests * moves creation of grpc server into cmd/netstate/main.go, removes pkg/netstate/service.go, adds more client testing * changed all 'Path' and 'Value' fields from strings to bytes, updated tests * changes Get and Delete in proto file to receive 'requests' instead of 'file paths', adds tests for Get, List, and Delete * changes netstate-routes to get 'fileValue' bytes not 'fileInfo' * adds example rpc client in 'examples' and adds more specific debug logs * adds readmes for netstate rpc services and updates netstate-routes 2018-05-15 01:31:26 +01:00
Flatten proto definitions into a single package (#360) * protos: move streams to pb * protos: move overlay to pb * protos: move pointerdb to pb * protos: move piecestore to pb * fix statdb import naming 2018-09-18 05:39:06 +01:00			If changes are made to `storj.io/storj/pkg/pb/pointerdb.proto`, the protobuf file will need to be regenerated by running `go generate` inside `pkg/pb`.
adding grpc interface to network state (#33) * adds proto files for netstate crud * moves netstate grpc client lib into pkg/netstate where grpc netstate service is defined * starts adding grpc client and server tests * moves creation of grpc server into cmd/netstate/main.go, removes pkg/netstate/service.go, adds more client testing * changed all 'Path' and 'Value' fields from strings to bytes, updated tests * changes Get and Delete in proto file to receive 'requests' instead of 'file paths', adds tests for Get, List, and Delete * changes netstate-routes to get 'fileValue' bytes not 'fileInfo' * adds example rpc client in 'examples' and adds more specific debug logs * adds readmes for netstate rpc services and updates netstate-routes 2018-05-15 01:31:26 +01:00
rename netstate to pointerdb (#127) * rename netstate to pointerdb 2018-07-06 20:43:53 +01:00			Tests for this example code can be found in `storj.io/storj/pkg/pointerdb/client_test.go`.