added package documentation
This commit is contained in:
parent
2be8d9e23c
commit
fe42b38eb6
6
pkg/store/backends/postgres/package.go
Normal file
6
pkg/store/backends/postgres/package.go
Normal file
@ -0,0 +1,6 @@
|
||||
// Package postgres is an implementation of a routes and neighbors
|
||||
// store using the postgres database.
|
||||
//
|
||||
// Routes and neighbors are stored as jsonb information
|
||||
// with indexes for query performance.
|
||||
package postgres
|
@ -113,6 +113,7 @@ func TestGetNeighbors(t *testing.T) {
|
||||
if err == nil {
|
||||
t.Error("Unknown source should have yielded zero results")
|
||||
}
|
||||
t.Log(neighbors)
|
||||
|
||||
}
|
||||
|
||||
|
8
pkg/store/package.go
Normal file
8
pkg/store/package.go
Normal file
@ -0,0 +1,8 @@
|
||||
// Package store provides an interface for keeping
|
||||
// routes and neighbor information without querying
|
||||
// a route server. The refresh happens in a configurable
|
||||
// interval.
|
||||
//
|
||||
// There a currently two implementations: A postgres and
|
||||
// and in-memory backend.
|
||||
package store
|
Loading…
x
Reference in New Issue
Block a user