Skip to content

Commit ed0ae76

Browse files
krishnamiriyalakrishnamiriyala
committed
Support pagination in FindAll* methods
``` - FindAll(ctx context.Context, records interface{}) error - FindWithFilter(ctx context.Context, record Record, records interface{}) error + FindAll(ctx context.Context, records interface{}, pagination *Pagination) error + FindWithFilter(ctx context.Context, filter Record, records interface{}, pagination *Pagination) error ``` Resolves PR #11
1 parent 790241f commit ed0ae76

9 files changed

+281
-99
lines changed

‎.golangci.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ linters-settings:
141141
- name: atomic
142142
- name: line-length-limit
143143
severity: error
144-
arguments: [ 330 ]
144+
arguments: [330]
145145
tagliatelle:
146146
# Check the struct tag name case.
147147
case:
@@ -172,6 +172,9 @@ issues:
172172
- gosec
173173
- typecheck
174174
- unparam
175+
- path: pkg/protostore/protostore_test.go
176+
linters:
177+
- maintidx
175178
- path: pkg/datastore/logger.go
176179
linters:
177180
- gochecknoglobals

‎docs/DOCUMENTATION.md

+61-17
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ type App struct {
107107
Revision int64 `gorm:"column:revision"`
108108
}
109109

110-
DataStore.RegisterWithDAL(context.TODO(), roleMappingForAppUser, appUser{})
110+
DataStore.Register(context.TODO(), roleMappingForAppUser, appUser{})
111111

112112
datastore.DataStore.Insert(ctx, user1)
113113
var queryResult appUser = appUser{Id: user1.Id}
@@ -158,6 +158,10 @@ tx.Commit()
158158
- [func FromConfig(l *logrus.Entry, authorizer authorizer.Authorizer, cfg DBConfig) (d DataStore, err error)](<#func-fromconfig>)
159159
- [func FromEnv(l *logrus.Entry, authorizer authorizer.Authorizer) (d DataStore, err error)](<#func-fromenv>)
160160
- [type Helper](<#type-helper>)
161+
- [type Pagination](<#type-pagination>)
162+
- [func DefaultPagination() *Pagination](<#func-defaultpagination>)
163+
- [func GetPagination(offset int, limit int, sortBy string) *Pagination](<#func-getpagination>)
164+
- [func NoPagination() *Pagination](<#func-nopagination>)
161165
- [type Record](<#type-record>)
162166
- [func GetRecordInstanceFromSlice(x interface{}) Record](<#func-getrecordinstancefromslice>)
163167
- [type TestHelper](<#type-testhelper>)
@@ -188,6 +192,14 @@ const (
188192
)
189193
```
190194

195+
```go
196+
const (
197+
DEFAULT_OFFSET = 0
198+
DEFAULT_LIMIT = 1000
199+
DEFAULT_SORTBY = ""
200+
)
201+
```
202+
191203
```go
192204
const (
193205
// Struct Field Names.
@@ -291,25 +303,27 @@ type DBConfig struct {
291303
}
292304
```
293305

294-
## type [DataStore](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/datastore/datastore.go#L81-L95>)
306+
## type [DataStore](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/datastore/datastore.go#L81-L97>)
295307

296308
DataStore /\*.
297309

298310
```go
299311
type DataStore interface {
300-
GetAuthorizer() authorizer.Authorizer
301312
Find(ctx context.Context, record Record) error
302-
FindAll(ctx context.Context, records interface{}) error
303-
FindWithFilter(ctx context.Context, record Record, records interface{}) error
313+
FindAll(ctx context.Context, records interface{}, pagination *Pagination) error
314+
FindWithFilter(ctx context.Context, filter Record, records interface{}, pagination *Pagination) error
304315
Insert(ctx context.Context, record Record) (int64, error)
305316
Delete(ctx context.Context, record Record) (int64, error)
306317
Update(ctx context.Context, record Record) (int64, error)
307318
Upsert(ctx context.Context, record Record) (int64, error)
308-
RegisterWithDAL(ctx context.Context, roleMapping map[string]dbrole.DbRole, record Record) error
319+
GetTransaction(ctx context.Context, record ...Record) (tx *gorm.DB, err error)
320+
321+
Register(ctx context.Context, roleMapping map[string]dbrole.DbRole, records ...Record) error
309322
Reset()
323+
324+
GetAuthorizer() authorizer.Authorizer
310325
Helper() Helper
311326
TestHelper() TestHelper
312-
GetTransaction(ctx context.Context, record ...Record) (tx *gorm.DB, err error)
313327
}
314328
```
315329

@@ -325,16 +339,46 @@ func FromConfig(l *logrus.Entry, authorizer authorizer.Authorizer, cfg DBConfig)
325339
func FromEnv(l *logrus.Entry, authorizer authorizer.Authorizer) (d DataStore, err error)
326340
```
327341

328-
## type [Helper](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/datastore/datastore.go#L97-L101>)
342+
## type [Helper](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/datastore/datastore.go#L99-L105>)
329343

330344
```go
331345
type Helper interface {
346+
FindAllInTable(ctx context.Context, tableName string, records interface{}, pagination *Pagination) error
347+
FindWithFilterInTable(ctx context.Context, tableName string, record Record, records interface{}, pagination *Pagination) error
332348
GetDBTransaction(ctx context.Context, tableName string, record Record) (tx *gorm.DB, err error)
333-
FindAllInTable(ctx context.Context, tableName string, records interface{}) error
334-
FindWithFilterInTable(ctx context.Context, tableName string, record Record, records interface{}) error
349+
350+
RegisterHelper(ctx context.Context, roleMapping map[string]dbrole.DbRole, tableName string, record Record) error
335351
}
336352
```
337353

354+
## type [Pagination](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/datastore/pagination.go#L27-L31>)
355+
356+
```go
357+
type Pagination struct {
358+
Offset int
359+
Limit int
360+
SortBy string
361+
}
362+
```
363+
364+
### func [DefaultPagination](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/datastore/pagination.go#L41>)
365+
366+
```go
367+
func DefaultPagination() *Pagination
368+
```
369+
370+
### func [GetPagination](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/datastore/pagination.go#L33>)
371+
372+
```go
373+
func GetPagination(offset int, limit int, sortBy string) *Pagination
374+
```
375+
376+
### func [NoPagination](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/datastore/pagination.go#L45>)
377+
378+
```go
379+
func NoPagination() *Pagination
380+
```
381+
338382
## type [Record](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/datastore/record.go#L23-L26>)
339383

340384
```go
@@ -348,7 +392,7 @@ type Record interface {
348392
func GetRecordInstanceFromSlice(x interface{}) Record
349393
```
350394

351-
## type [TestHelper](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/datastore/datastore.go#L103-L107>)
395+
## type [TestHelper](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/datastore/datastore.go#L107-L111>)
352396

353397
```go
354398
type TestHelper interface {
@@ -656,8 +700,8 @@ protoStore.DeleteById(ctx, id, &pb.Memory{})
656700
- [type ProtobufDataStore](<#type-protobufdatastore>)
657701
- [func (p ProtobufDataStore) DeleteById(ctx context.Context, id string, msg proto.Message) (int64, error)](<#func-protobufdatastore-deletebyid>)
658702
- [func (p ProtobufDataStore) DropTables(msgs ...proto.Message) error](<#func-protobufdatastore-droptables>)
659-
- [func (p ProtobufDataStore) FindAll(ctx context.Context, msgs interface{}) (metadataMap map[string]Metadata, err error)](<#func-protobufdatastore-findall>)
660-
- [func (p ProtobufDataStore) FindAllAsMap(ctx context.Context, msgsMap interface{}) (metadataMap map[string]Metadata, err error)](<#func-protobufdatastore-findallasmap>)
703+
- [func (p ProtobufDataStore) FindAll(ctx context.Context, msgs interface{}, pagination *datastore.Pagination) (metadataMap map[string]Metadata, err error)](<#func-protobufdatastore-findall>)
704+
- [func (p ProtobufDataStore) FindAllAsMap(ctx context.Context, msgsMap interface{}, pagination *datastore.Pagination) (metadataMap map[string]Metadata, err error)](<#func-protobufdatastore-findallasmap>)
661705
- [func (p ProtobufDataStore) FindById(ctx context.Context, id string, msg proto.Message, metadata *Metadata) error](<#func-protobufdatastore-findbyid>)
662706
- [func (p ProtobufDataStore) GetAuthorizer() authorizer.Authorizer](<#func-protobufdatastore-getauthorizer>)
663707
- [func (p ProtobufDataStore) GetMetadata(ctx context.Context, id string, msg proto.Message) (md Metadata, err error)](<#func-protobufdatastore-getmetadata>)
@@ -712,8 +756,8 @@ type ProtoStore interface {
712756
Update(ctx context.Context, id string, msg proto.Message) (rowsAffected int64, md Metadata, err error)
713757
Upsert(ctx context.Context, id string, msg proto.Message) (rowsAffected int64, md Metadata, err error)
714758
FindById(ctx context.Context, id string, msg proto.Message, metadata *Metadata) error
715-
FindAll(ctx context.Context, msgs interface{}) (metadataMap map[string]Metadata, err error)
716-
FindAllAsMap(ctx context.Context, msgsMap interface{}) (metadataMap map[string]Metadata, err error)
759+
FindAll(ctx context.Context, msgs interface{}, pagination *datastore.Pagination) (metadataMap map[string]Metadata, err error)
760+
FindAllAsMap(ctx context.Context, msgsMap interface{}, pagination *datastore.Pagination) (metadataMap map[string]Metadata, err error)
717761
DeleteById(ctx context.Context, id string, msg proto.Message) (rowsAffected int64, err error)
718762

719763
InsertWithMetadata(ctx context.Context, id string, msg proto.Message, metadata Metadata) (rowsAffected int64, md Metadata, err error)
@@ -781,15 +825,15 @@ func (p ProtobufDataStore) DropTables(msgs ...proto.Message) error
781825
### func \(ProtobufDataStore\) [FindAll](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/protostore/protostore.go#L386>)
782826

783827
```go
784-
func (p ProtobufDataStore) FindAll(ctx context.Context, msgs interface{}) (metadataMap map[string]Metadata, err error)
828+
func (p ProtobufDataStore) FindAll(ctx context.Context, msgs interface{}, pagination *datastore.Pagination) (metadataMap map[string]Metadata, err error)
785829
```
786830

787831
FindAll Finds all messages \(of the same type as the element of msgs\) in Protostore and stores the result in msgs. msgs must be a pointer to a slice of Protobuf structs or a pointer to a slice of pointers to Protobuf structs. It will be modified in\-place. Returns a map of Protobuf messages' IDs to their metadata \(parent ID & revision\).
788832

789833
### func \(ProtobufDataStore\) [FindAllAsMap](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/protostore/protostore.go#L328>)
790834

791835
```go
792-
func (p ProtobufDataStore) FindAllAsMap(ctx context.Context, msgsMap interface{}) (metadataMap map[string]Metadata, err error)
836+
func (p ProtobufDataStore) FindAllAsMap(ctx context.Context, msgsMap interface{}, pagination *datastore.Pagination) (metadataMap map[string]Metadata, err error)
793837
```
794838

795839
### func \(ProtobufDataStore\) [FindById](<https://github.com/vmware-labs/multi-tenant-persistence-for-saas/blob/main/pkg/protostore/protostore.go#L294>)

‎pkg/datastore/database.go

+26-12
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ func (db *relationalDb) FindInTable(ctx context.Context, tableName string, recor
208208

209209
// Finds all records in a DB table.
210210
// records must be a pointer to a slice of structs and will be modified in-place.
211-
func (db *relationalDb) FindAll(ctx context.Context, records interface{}) error {
211+
func (db *relationalDb) FindAll(ctx context.Context, records interface{}, pagination *Pagination) error {
212212
if reflect.TypeOf(records).Kind() != reflect.Ptr || reflect.TypeOf(records).Elem().Kind() != reflect.Slice {
213213
errMsg := "\"records\" argument has to be a pointer to a slice of structs implementing \"Record\" interface"
214214
err := ErrNotPtrToStructSlice.Wrap(fmt.Errorf(errMsg))
@@ -217,27 +217,27 @@ func (db *relationalDb) FindAll(ctx context.Context, records interface{}) error
217217
}
218218

219219
tableName := GetTableName(records)
220-
return db.FindAllInTable(ctx, tableName, records)
220+
return db.FindAllInTable(ctx, tableName, records, pagination)
221221
}
222222

223223
// FindAllInTable Finds all records in DB table tableName.
224224
// records must be a pointer to a slice of structs and will be modified in-place.
225-
func (db *relationalDb) FindAllInTable(ctx context.Context, tableName string, records interface{}) error {
225+
func (db *relationalDb) FindAllInTable(ctx context.Context, tableName string, records interface{}, pagination *Pagination) error {
226226
record := GetRecordInstanceFromSlice(records)
227-
return db.FindWithFilterInTable(ctx, tableName, record, records)
227+
return db.FindWithFilterInTable(ctx, tableName, record, records, pagination)
228228
}
229229

230230
// FindWithFilter Finds multiple records in a DB table.
231231
// If record argument is non-empty, uses the non-empty fields as criteria in a query.
232232
// records must be a pointer to a slice of structs and will be modified in-place.
233-
func (db *relationalDb) FindWithFilter(ctx context.Context, record Record, records interface{}) error {
234-
return db.FindWithFilterInTable(ctx, GetTableName(record), record, records)
233+
func (db *relationalDb) FindWithFilter(ctx context.Context, record Record, records interface{}, pagination *Pagination) error {
234+
return db.FindWithFilterInTable(ctx, GetTableName(record), record, records, pagination)
235235
}
236236

237237
// Finds multiple records in DB table tableName.
238238
// If record argument is non-empty, uses the non-empty fields as criteria in a query.
239239
// records must be a pointer to a slice of structs and will be modified in-place.
240-
func (db *relationalDb) FindWithFilterInTable(ctx context.Context, tableName string, record Record, records interface{}) (err error) {
240+
func (db *relationalDb) FindWithFilterInTable(ctx context.Context, tableName string, record Record, records interface{}, pagination *Pagination) (err error) {
241241
if reflect.TypeOf(records).Kind() != reflect.Ptr || reflect.TypeOf(records).Elem().Kind() != reflect.Slice {
242242
return ErrNotPtrToStruct.WithValue(TYPE, TypeName(records))
243243
}
@@ -247,7 +247,15 @@ func (db *relationalDb) FindWithFilterInTable(ctx context.Context, tableName str
247247
return err
248248
}
249249

250-
tx.Where(record).Find(records) // FILTER by record too
250+
tx.Where(record)
251+
if pagination != nil {
252+
tx.Offset(pagination.Offset).Limit(pagination.Limit)
253+
if pagination.SortBy != "" {
254+
tx.Order(pagination.SortBy)
255+
}
256+
}
257+
tx.Find(records)
258+
251259
tx.Commit()
252260
if tx.Error != nil {
253261
err = ErrExecutingSqlStmt.Wrap(tx.Error)
@@ -411,9 +419,15 @@ func (db *relationalDb) UpdateInTable(ctx context.Context, tableName string, rec
411419
return tx.RowsAffected, nil
412420
}
413421

414-
// Registers a struct with DAL. See RegisterWithDALHelper() for more info.
415-
func (db *relationalDb) RegisterWithDAL(ctx context.Context, roleMapping map[string]dbrole.DbRole, record Record) error {
416-
return db.RegisterWithDALHelper(ctx, roleMapping, GetTableName(record), record)
422+
// Registers a struct with DAL. See RegisterHelper() for more info.
423+
func (db *relationalDb) Register(ctx context.Context, roleMapping map[string]dbrole.DbRole, records ...Record) error {
424+
for _, record := range records {
425+
err := db.RegisterHelper(ctx, roleMapping, GetTableName(record), record)
426+
if err != nil {
427+
return err
428+
}
429+
}
430+
return nil
417431
}
418432

419433
// Create a DB table for the given struct. Enables RLS in it if it is multi-tenant.
@@ -425,7 +439,7 @@ func (db *relationalDb) RegisterWithDAL(ctx context.Context, roleMapping map[str
425439
// - WRITER, which gives read & write access to all the records in the table
426440
// - TENANT_READER, which gives read access to current tenant's records
427441
// - TENANT_WRITER, which gives read & write access to current tenant's records.
428-
func (db *relationalDb) RegisterWithDALHelper(_ context.Context, roleMapping map[string]dbrole.DbRole, tableName string, record Record) (err error) {
442+
func (db *relationalDb) RegisterHelper(_ context.Context, roleMapping map[string]dbrole.DbRole, tableName string, record Record) (err error) {
429443
if roleMapping == nil {
430444
roleMapping = make(map[string]dbrole.DbRole)
431445
}

‎pkg/datastore/datastore.go

+12-8
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
// Revision int64 `gorm:"column:revision"`
3838
// }
3939
//
40-
// DataStore.RegisterWithDAL(context.TODO(), roleMappingForAppUser, appUser{})
40+
// DataStore.Register(context.TODO(), roleMappingForAppUser, appUser{})
4141
//
4242
// datastore.DataStore.Insert(ctx, user1)
4343
// var queryResult appUser = appUser{Id: user1.Id}
@@ -79,25 +79,29 @@ import (
7979

8080
// DataStore /*.
8181
type DataStore interface {
82-
GetAuthorizer() authorizer.Authorizer
8382
Find(ctx context.Context, record Record) error
84-
FindAll(ctx context.Context, records interface{}) error
85-
FindWithFilter(ctx context.Context, record Record, records interface{}) error
83+
FindAll(ctx context.Context, records interface{}, pagination *Pagination) error
84+
FindWithFilter(ctx context.Context, filter Record, records interface{}, pagination *Pagination) error
8685
Insert(ctx context.Context, record Record) (int64, error)
8786
Delete(ctx context.Context, record Record) (int64, error)
8887
Update(ctx context.Context, record Record) (int64, error)
8988
Upsert(ctx context.Context, record Record) (int64, error)
90-
RegisterWithDAL(ctx context.Context, roleMapping map[string]dbrole.DbRole, record Record) error
89+
GetTransaction(ctx context.Context, record ...Record) (tx *gorm.DB, err error)
90+
91+
Register(ctx context.Context, roleMapping map[string]dbrole.DbRole, records ...Record) error
9192
Reset()
93+
94+
GetAuthorizer() authorizer.Authorizer
9295
Helper() Helper
9396
TestHelper() TestHelper
94-
GetTransaction(ctx context.Context, record ...Record) (tx *gorm.DB, err error)
9597
}
9698

9799
type Helper interface {
100+
FindAllInTable(ctx context.Context, tableName string, records interface{}, pagination *Pagination) error
101+
FindWithFilterInTable(ctx context.Context, tableName string, record Record, records interface{}, pagination *Pagination) error
98102
GetDBTransaction(ctx context.Context, tableName string, record Record) (tx *gorm.DB, err error)
99-
FindAllInTable(ctx context.Context, tableName string, records interface{}) error
100-
FindWithFilterInTable(ctx context.Context, tableName string, record Record, records interface{}) error
103+
104+
RegisterHelper(ctx context.Context, roleMapping map[string]dbrole.DbRole, tableName string, record Record) error
101105
}
102106

103107
type TestHelper interface {

0 commit comments

Comments
 (0)