Add 'user friendly' datastore API.

impl/memory/raw_datastore_query.go

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package memory
 
 import (
         "bytes"
         "errors"
         "fmt"
         "math"
         "strings"
 
-        rds "github.com/luci/gae/service/rawdatastore"
+        ds "github.com/luci/gae/service/datastore"
         "github.com/luci/gkvlite"
         "github.com/luci/luci-go/common/cmpbin"
 )
 
 type qDirection bool
 
 const (
         qASC qDirection = true
         qDEC            = false
 )
@@ skipping 187 matching lines @@
 
 type queryCursor string
 
 func (q queryCursor) String() string { return string(q) }
 func (q queryCursor) Valid() bool    { return q != "" }
 
 type queryImpl struct {
         ns string
 
         kind     string
-        ancestor rds.Key
+        ancestor ds.Key
         filter   []queryFilter
         order    []queryOrder
         project  []string
 
         distinct            bool
         eventualConsistency bool
         keysOnly            bool
         limit               int32
         offset              int32
 
         start queryCursor
         end   queryCursor
 
         err error
 }
 
-var _ rds.Query = (*queryImpl)(nil)
+var _ ds.Query = (*queryImpl)(nil)
 
 func (q *queryImpl) normalize() (ret *queryImpl) {
         // ported from GAE SDK datastore_index.py;Normalize()
         ret = q.clone()
 
         bs := newMemStore()
 
         eqProperties := bs.MakePrivateCollection(nil)
 
         ineqProperties := bs.MakePrivateCollection(nil)
@@ skipping 109 matching lines @@
         //   "query app is x but ancestor app is x"
         // if ret.ancestor.namespace() != current namespace
         //   "query namespace is x but ancestor namespace is x"
 
         // if not all(g in orders for g in group_by)
         //  "items in the group by clause must be specified first in the ordering"
 
         ineqPropName := ""
         for _, f := range ret.filter {
                 if f.field == "__key__" {
-                        k, ok := f.value.(rds.Key)
+                        k, ok := f.value.(ds.Key)
                         if !ok {
                                 ret.err = errors.New(
                                         "gae/memory: __key__ filter value must be a Key")
                                 return
                         }
-                        if !rds.KeyValid(k, false, globalAppID, q.ns) {
+                        if !ds.KeyValid(k, false, globalAppID, q.ns) {
                                 // See the comment in queryImpl.Ancestor; basically this check
                                 // never happens in the real env because the SDK silently swallows
                                 // this condition :/
-                                ret.err = rds.ErrInvalidKey
+                                ret.err = ds.ErrInvalidKey
                                 return
                         }
                         if k.Namespace() != ns {
                                 ret.err = fmt.Errorf("bad namespace: %q (expected %q)", k.Namespace(), ns)
                                 return
                         }
                         // __key__ filter app is X but query app is X
                         // __key__ filter namespace is X but query namespace is X
                 }
                 // if f.op == qEqual and f.field in ret.project_fields
@@ skipping 61 matching lines @@
 }
 
 func (q *queryImpl) clone() *queryImpl {
         ret := *q
         ret.filter = append([]queryFilter(nil), q.filter...)
         ret.order = append([]queryOrder(nil), q.order...)
         ret.project = append([]string(nil), q.project...)
         return &ret
 }
 
-func (q *queryImpl) Ancestor(k rds.Key) rds.Query {
+func (q *queryImpl) Ancestor(k ds.Key) ds.Query {
         q = q.clone()
         q.ancestor = k
         if k == nil {
                 // SDK has an explicit nil-check
                 q.err = errors.New("datastore: nil query ancestor")
-        } else if !rds.KeyValid(k, false, globalAppID, q.ns) {
+        } else if !ds.KeyValid(k, false, globalAppID, q.ns) {
                 // technically the SDK implementation does a Weird Thing (tm) if both the
                 // stringID and intID are set on a key; it only serializes the stringID in
                 // the proto. This means that if you set the Ancestor to an invalid key,
                 // you'll never actually hear about it. Instead of doing that insanity, we
                 // just swap to an error here.
-                q.err = rds.ErrInvalidKey
+                q.err = ds.ErrInvalidKey
         } else if k.Namespace() != q.ns {
                 q.err = fmt.Errorf("bad namespace: %q (expected %q)", k.Namespace(), q.ns)
         }
         return q
 }
 
-func (q *queryImpl) Distinct() rds.Query {
+func (q *queryImpl) Distinct() ds.Query {
         q = q.clone()
         q.distinct = true
         return q
 }
 
-func (q *queryImpl) Filter(fStr string, val interface{}) rds.Query {
+func (q *queryImpl) Filter(fStr string, val interface{}) ds.Query {
         q = q.clone()
         f, err := parseFilter(fStr, val)
         if err != nil {
                 q.err = err
                 return q
         }
         q.filter = append(q.filter, f)
         return q
 }
 
-func (q *queryImpl) Order(field string) rds.Query {
+func (q *queryImpl) Order(field string) ds.Query {
         q = q.clone()
         field = strings.TrimSpace(field)
         o := queryOrder{field, qASC}
         if strings.HasPrefix(field, "-") {
                 o.direction = qDEC
                 o.field = strings.TrimSpace(field[1:])
         } else if strings.HasPrefix(field, "+") {
                 q.err = fmt.Errorf("datastore: invalid order: %q", field)
                 return q
         }
         if len(o.field) == 0 {
                 q.err = errors.New("datastore: empty order")
                 return q
         }
         q.order = append(q.order, o)
         return q
 }
 
-func (q *queryImpl) Project(fieldName ...string) rds.Query {
+func (q *queryImpl) Project(fieldName ...string) ds.Query {
         q = q.clone()
         q.project = append(q.project, fieldName...)
         return q
 }
 
-func (q *queryImpl) KeysOnly() rds.Query {
+func (q *queryImpl) KeysOnly() ds.Query {
         q = q.clone()
         q.keysOnly = true
         return q
 }
 
-func (q *queryImpl) Limit(limit int) rds.Query {
+func (q *queryImpl) Limit(limit int) ds.Query {
         q = q.clone()
         if limit < math.MinInt32 || limit > math.MaxInt32 {
                 q.err = errors.New("datastore: query limit overflow")
                 return q
         }
         q.limit = int32(limit)
         return q
 }
 
-func (q *queryImpl) Offset(offset int) rds.Query {
+func (q *queryImpl) Offset(offset int) ds.Query {
         q = q.clone()
         if offset < 0 {
                 q.err = errors.New("datastore: negative query offset")
                 return q
         }
         if offset > math.MaxInt32 {
                 q.err = errors.New("datastore: query offset overflow")
                 return q
         }
         q.offset = int32(offset)
         return q
 }
 
-func (q *queryImpl) Start(c rds.Cursor) rds.Query {
+func (q *queryImpl) Start(c ds.Cursor) ds.Query {
         q = q.clone()
         curs := c.(queryCursor)
         if !curs.Valid() {
                 q.err = errors.New("datastore: invalid cursor")
                 return q
         }
         q.start = curs
         return q
 }
 
-func (q *queryImpl) End(c rds.Cursor) rds.Query {
+func (q *queryImpl) End(c ds.Cursor) ds.Query {
         q = q.clone()
         curs := c.(queryCursor)
         if !curs.Valid() {
                 q.err = errors.New("datastore: invalid cursor")
                 return q
         }
         q.end = curs
         return q
 }
 
-func (q *queryImpl) EventualConsistency() rds.Query {
+func (q *queryImpl) EventualConsistency() ds.Query {
         q = q.clone()
         q.eventualConsistency = true
         return q
 }