refactor: Rename key,id,dockey to docID terminology

Makefile

@@ -217,11 +217,26 @@ test\:cli:
 test\:names:
 	gotestsum --format testname -- $(DEFAULT_TEST_DIRECTORIES) $(TEST_FLAGS)
 
+.PHONY: test\:lens
+test\:lens:
+	@$(MAKE) deps:lens
+	gotestsum --format testname -- ./$(LENS_TEST_DIRECTORY)/... $(TEST_FLAGS)
+
+.PHONY: test\:lens-quick
+test\:lens-quick:
+	@$(MAKE) deps:lens
+	gotestsum --format testname -- ./$(LENS_TEST_DIRECTORY)/...
+
 .PHONY: test\:all
 test\:all:
 	@$(MAKE) test:names
 	@$(MAKE) test:lens
 
+.PHONY: test\:all-quick
+test\:all-quick:
+	@$(MAKE) test:quick
+	@$(MAKE) test:lens-quick
+
 .PHONY: test\:verbose
 test\:verbose:
 	gotestsum --format standard-verbose -- $(DEFAULT_TEST_DIRECTORIES) $(TEST_FLAGS)
@@ -246,11 +261,6 @@ test\:bench-short:
 test\:scripts:
 	@$(MAKE) -C ./tools/scripts/ test
 
-.PHONY: test\:lens
-test\:lens:
-	@$(MAKE) deps:lens
-	gotestsum --format testname -- ./$(LENS_TEST_DIRECTORY)/... $(TEST_FLAGS)
-
 .PHONY: test\:coverage
 test\:coverage:
 	@$(MAKE) deps:lens

README.md

@@ -101,7 +101,7 @@ Submit a `mutation` request to create a document of the `User` type:
 defradb client query '
   mutation {
       create_User(data: "{\"age\": 31, \"verified\": true, \"points\": 90, \"name\": \"Bob\"}") {
-          _key
+          _docID
       }
   }
 '
@@ -113,13 +113,13 @@ Expected response:
 {
   "data": [
     {
-      "_key": "bae-91171025-ed21-50e3-b0dc-e31bccdfa1ab",
+      "_docID": "bae-91171025-ed21-50e3-b0dc-e31bccdfa1ab",
     }
   ]
 }
 ```
 
-`_key` is the document's key, a unique identifier of the document, determined by its schema and initial data.
+`_docID` is the document's unique identifier determined by its schema and initial data.
 
 ## Query documents
 
@@ -129,7 +129,7 @@ Once you have populated your node with data, you can query it:
 defradb client query '
   query {
     User {
-      _key
+      _docID
       age
       name
       points
@@ -138,15 +138,15 @@ defradb client query '
 '
 ```
 
-This query obtains *all* users and returns their fields `_key, age, name, points`. GraphQL queries only return the exact fields requested.
+This query obtains *all* users and returns their fields `_docID, age, name, points`. GraphQL queries only return the exact fields requested.
 
 You can further filter results with the `filter` argument.
 
 ```shell
 defradb client query '
   query {
     User(filter: {points: {_ge: 50}}) {
-      _key
+      _docID
       age
       name
       points
@@ -166,7 +166,7 @@ To get the most recent commit in the MerkleDAG for the document identified as `b
 ```shell
 defradb client query '
   query {
-    latestCommits(dockey: "bae-91171025-ed21-50e3-b0dc-e31bccdfa1ab") {
+    latestCommits(docID: "bae-91171025-ed21-50e3-b0dc-e31bccdfa1ab") {
       cid
       delta
       height

cli/cli.go

@@ -91,7 +91,7 @@ func NewDefraCommand(cfg *config.Config) *cobra.Command {
 	collection := MakeCollectionCommand(cfg)
 	collection.AddCommand(
 		MakeCollectionGetCommand(),
-		MakeCollectionKeysCommand(),
+		MakeCollectionListDocIDsCommand(),
 		MakeCollectionDeleteCommand(),
 		MakeCollectionUpdateCommand(),
 		MakeCollectionCreateCommand(),

cli/collection_delete.go

@@ -17,15 +17,15 @@
 )
 
 func MakeCollectionDeleteCommand() *cobra.Command {
-	var keys []string
+	var argDocIDs []string
 	var filter string
 	var cmd = &cobra.Command{
-		Use:   "delete [--filter <filter> --key <key>]",
-		Short: "Delete documents by key or filter.",
-		Long: `Delete documents by key or filter and lists the number of documents deleted.
+		Use:   "delete [--filter <filter> --docID <docID>]",
+		Short: "Delete documents by docID or filter.",
+		Long: `Delete documents by docID or filter and lists the number of documents deleted.
 
-Example: delete by key(s)
-  defradb client collection delete --name User --key bae-123,bae-456
+Example: delete by docID(s)
+  defradb client collection delete --name User --docID bae-123,bae-456
 
 Example: delete by filter
   defradb client collection delete --name User --filter '{ "_gte": { "points": 100 } }'
@@ -37,26 +37,26 @@
 			}
 
 			switch {
-			case len(keys) == 1:
-				docKey, err := client.NewDocKeyFromString(keys[0])
+			case len(argDocIDs) == 1:
+				docID, err := client.NewDocIDFromString(argDocIDs[0])
 				if err != nil {
 					return err
 				}
-				res, err := col.DeleteWithKey(cmd.Context(), docKey)
+				res, err := col.DeleteWithDocID(cmd.Context(), docID)
 				if err != nil {
 					return err
 				}
 				return writeJSON(cmd, res)
-			case len(keys) > 1:
-				docKeys := make([]client.DocKey, len(keys))
-				for i, v := range keys {
-					docKey, err := client.NewDocKeyFromString(v)
+			case len(argDocIDs) > 1:
+				docIDs := make([]client.DocID, len(argDocIDs))
+				for i, v := range argDocIDs {
+					docID, err := client.NewDocIDFromString(v)
 					if err != nil {
 						return err
 					}
-					docKeys[i] = docKey
+					docIDs[i] = docID
 				}
-				res, err := col.DeleteWithKeys(cmd.Context(), docKeys)
+				res, err := col.DeleteWithDocIDs(cmd.Context(), docIDs)
 				if err != nil {
 					return err
 				}
@@ -68,11 +68,11 @@
 				}
 				return writeJSON(cmd, res)
 			default:
-				return ErrNoDocKeyOrFilter
+				return ErrNoDocIDOrFilter
 			}
 		},
 	}
-	cmd.Flags().StringSliceVar(&keys, "key", nil, "Document key")
+	cmd.Flags().StringSliceVar(&argDocIDs, "docID", nil, "Document ID")
 	cmd.Flags().StringVar(&filter, "filter", "", "Document filter")
 	return cmd
 }

cli/collection_get.go

@@ -19,7 +19,7 @@ import (
 func MakeCollectionGetCommand() *cobra.Command {
 	var showDeleted bool
 	var cmd = &cobra.Command{
-		Use:   "get <docKey> [--show-deleted]",
+		Use:   "get <docID> [--show-deleted]",
 		Short: "View document fields.",
 		Long: `View document fields.
 
@@ -33,11 +33,11 @@ Example:
 				return cmd.Usage()
 			}
 
-			docKey, err := client.NewDocKeyFromString(args[0])
+			docID, err := client.NewDocIDFromString(args[0])
 			if err != nil {
 				return err
 			}
-			doc, err := col.Get(cmd.Context(), docKey, showDeleted)
+			doc, err := col.Get(cmd.Context(), docID, showDeleted)
 			if err != nil {
 				return err
 			}

cli/collection_keys.go → cli/collection_list_doc_ids.go

@@ -16,31 +16,31 @@
 	"github.com/sourcenetwork/defradb/http"
 )
 
-func MakeCollectionKeysCommand() *cobra.Command {
+func MakeCollectionListDocIDsCommand() *cobra.Command {
 	var cmd = &cobra.Command{
-		Use:   "keys",
-		Short: "List all document keys.",
-		Long: `List all document keys.
+		Use:   "docIDs",
+		Short: "List all document IDs (docIDs).",
+		Long: `List all document IDs (docIDs).
 
 Example:
-  defradb client collection keys --name User
+  defradb client collection docIDs --name User
 		`,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			col, ok := tryGetCollectionContext(cmd)
 			if !ok {
 				return cmd.Usage()
 			}
 
-			docCh, err := col.GetAllDocKeys(cmd.Context())
+			docCh, err := col.GetAllDocIDs(cmd.Context())
 			if err != nil {
 				return err
 			}
-			for docKey := range docCh {
-				results := &http.DocKeyResult{
-					Key: docKey.Key.String(),
+			for docIDResult := range docCh {
+				results := &http.DocIDResult{
+					DocID: docIDResult.ID.String(),
 				}
-				if docKey.Err != nil {
-					results.Error = docKey.Err.Error()
+				if docIDResult.Err != nil {
+					results.Error = docIDResult.Err.Error()
 				}
 				if err := writeJSON(cmd, results); err != nil {
 					return err

cli/collection_update.go

@@ -17,24 +17,24 @@
 )
 
 func MakeCollectionUpdateCommand() *cobra.Command {
-	var keys []string
+	var argDocIDs []string
 	var filter string
 	var updater string
 	var cmd = &cobra.Command{
-		Use:   "update [--filter <filter> --key <key> --updater <updater>] <document>",
-		Short: "Update documents by key or filter.",
-		Long: `Update documents by key or filter.
+		Use:   "update [--filter <filter> --docID <docID> --updater <updater>] <document>",
+		Short: "Update documents by docID or filter.",
+		Long: `Update documents by docID or filter.
 
 Example: update from string
-  defradb client collection update --name User --key bae-123 '{ "name": "Bob" }'
+  defradb client collection update --name User --docID bae-123 '{ "name": "Bob" }'
 
 Example: update by filter
   defradb client collection update --name User \
   --filter '{ "_gte": { "points": 100 } }' --updater '{ "verified": true }'
 
-Example: update by keys
+Example: update by docIDs
   defradb client collection update --name User \
-  --key bae-123,bae-456 --updater '{ "verified": true }'
+  --docID bae-123,bae-456 --updater '{ "verified": true }'
 		`,
 		Args: cobra.RangeArgs(0, 1),
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -44,26 +44,26 @@
 			}
 
 			switch {
-			case len(keys) == 1 && updater != "":
-				docKey, err := client.NewDocKeyFromString(keys[0])
+			case len(argDocIDs) == 1 && updater != "":
+				docID, err := client.NewDocIDFromString(argDocIDs[0])
 				if err != nil {
 					return err
 				}
-				res, err := col.UpdateWithKey(cmd.Context(), docKey, updater)
+				res, err := col.UpdateWithDocID(cmd.Context(), docID, updater)
 				if err != nil {
 					return err
 				}
 				return writeJSON(cmd, res)
-			case len(keys) > 1 && updater != "":
-				docKeys := make([]client.DocKey, len(keys))
-				for i, v := range keys {
-					docKey, err := client.NewDocKeyFromString(v)
+			case len(argDocIDs) > 1 && updater != "":
+				docIDs := make([]client.DocID, len(argDocIDs))
+				for i, v := range argDocIDs {
+					docID, err := client.NewDocIDFromString(v)
 					if err != nil {
 						return err
 					}
-					docKeys[i] = docKey
+					docIDs[i] = docID
 				}
-				res, err := col.UpdateWithKeys(cmd.Context(), docKeys, updater)
+				res, err := col.UpdateWithDocIDs(cmd.Context(), docIDs, updater)
 				if err != nil {
 					return err
 				}
@@ -74,12 +74,12 @@
 					return err
 				}
 				return writeJSON(cmd, res)
-			case len(keys) == 1 && len(args) == 1:
-				docKey, err := client.NewDocKeyFromString(keys[0])
+			case len(argDocIDs) == 1 && len(args) == 1:
+				docID, err := client.NewDocIDFromString(argDocIDs[0])
 				if err != nil {
 					return err
 				}
-				doc, err := col.Get(cmd.Context(), docKey, true)
+				doc, err := col.Get(cmd.Context(), docID, true)
 				if err != nil {
 					return err
 				}
@@ -88,11 +88,11 @@
 				}
 				return col.Update(cmd.Context(), doc)
 			default:
-				return ErrNoDocKeyOrFilter
+				return ErrNoDocIDOrFilter
 			}
 		},
 	}
-	cmd.Flags().StringSliceVar(&keys, "key", nil, "Document key")
+	cmd.Flags().StringSliceVar(&argDocIDs, "docID", nil, "Document ID")
 	cmd.Flags().StringVar(&filter, "filter", "", "Document filter")
 	cmd.Flags().StringVar(&updater, "updater", "", "Document updater")
 	return cmd

cli/errors.go

@@ -22,7 +22,7 @@ const (
 var (
 	ErrNoDocOrFile              = errors.New("document or file must be defined")
 	ErrInvalidDocument          = errors.New("invalid document")
-	ErrNoDocKeyOrFilter         = errors.New("document key or filter must be defined")
+	ErrNoDocIDOrFilter          = errors.New("docID or filter must be defined")
 	ErrInvalidExportFormat      = errors.New("invalid export format")
 	ErrNoLensConfig             = errors.New("lens config cannot be empty")
 	ErrInvalidLensConfig        = errors.New("invalid lens configuration")

cli/version_test.go

@@ -42,7 +42,7 @@ func TestVersionFull(t *testing.T) {
 	assert.NoError(t, err)
 	t.Log(buf.String())
 	assert.Contains(t, buf.String(), "* HTTP API")
-	assert.Contains(t, buf.String(), "* DocKey versions")
+	assert.Contains(t, buf.String(), "* DocID versions")
 	assert.Contains(t, buf.String(), "* P2P multicodec")
 }
 
@@ -59,11 +59,11 @@ func TestVersionJSON(t *testing.T) {
 	{
 		"release": "",
 		"commit": "",
-		"commitdate": "",
+		"commitDate": "",
 		"go": "",
-		"httpapi": "v0",
-		"dockeyversions": "1",
-		"netprotocol": "/defra/0.0.1"
+		"httpAPI": "v0",
+		"docIDVersions": "1",
+		"netProtocol": "/defra/0.0.1"
 	}`)
 }
 
@@ -80,10 +80,10 @@ func TestVersionJSONFull(t *testing.T) {
 	{
 		"release": "",
 		"commit": "",
-		"commitdate": "",
+		"commitDate": "",
 		"go": "",
-		"httpapi": "v0",
-		"dockeyversions": "1",
-		"netprotocol": "/defra/0.0.1"
+		"httpAPI": "v0",
+		"docIDVersions": "1",
+		"netProtocol": "/defra/0.0.1"
 	}`)
 }