[Feature] [3.7] Schema validation options (#274)

Author: ajanikow

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [master](https://github.com/arangodb/go-driver/tree/master) (N/A)
 - Use internal coordinator communication for cursors if specified coordinator was not found on endpoint list
 - Add support for Overwrite Mode (ArangoDB 3.7)
+- Add support for Schema Collection options (ArangoDB 3.7)
 
 ## [1.0.0](https://github.com/arangodb/go-driver/tree/1.0.0) (N/A)
 - Enable proper CHANGELOG and versioning

collection.go

@@ -143,6 +143,8 @@ type CollectionProperties struct {
 	// The following attribute specifies if the new MerkleTree based sync protocol
 	// can be used on the collection.
 	SyncByRevision bool `json:"syncByRevision,omitempty"`
+	// Schema for collection validation
+	Schema *CollectionSchemaOptions `json:"schema,omitempty"`
 }
 
 const (
@@ -171,6 +173,8 @@ type SetCollectionPropertiesOptions struct {
 	WriteConcern int `json:"writeConcern,omitempty"`
 	// CacheEnabled set cacheEnabled option in collection properties
 	CacheEnabled *bool `json:"cacheEnabled,omitempty"`
+	// Schema for collection validation
+	Schema *CollectionSchemaOptions `json:"schema,omitempty"`
 }
 
 // CollectionStatus indicates the status of a collection.

collection_impl.go

@@ -286,8 +286,9 @@ type collectionPropertiesInternal struct {
 	ShardingStrategy     ShardingStrategy `json:"shardingStrategy,omitempty"`
 	DistributeShardsLike string           `json:"distributeShardsLike,omitempty"`
 	// Available from 3.7 arangod version.
-	UsesRevisionsAsDocumentIds bool `json:"usesRevisionsAsDocumentIds,omitempty"`
-	SyncByRevision             bool `json:"syncByRevision,omitempty"`
+	UsesRevisionsAsDocumentIds bool                     `json:"usesRevisionsAsDocumentIds,omitempty"`
+	SyncByRevision             bool                     `json:"syncByRevision,omitempty"`
+	Schema                     *CollectionSchemaOptions `json:"schema,omitempty"`
 }
 
 func (p *collectionPropertiesInternal) asExternal() CollectionProperties {
@@ -308,6 +309,7 @@ func (p *collectionPropertiesInternal) asExternal() CollectionProperties {
 		DistributeShardsLike:       p.DistributeShardsLike,
 		UsesRevisionsAsDocumentIds: p.UsesRevisionsAsDocumentIds,
 		SyncByRevision:             p.SyncByRevision,
+		Schema:                     p.Schema,
 	}
 }
 
@@ -326,6 +328,7 @@ func (p *CollectionProperties) asInternal() collectionPropertiesInternal {
 		WriteConcern:         p.WriteConcern,
 		SmartJoinAttribute:   p.SmartJoinAttribute,
 		ShardingStrategy:     p.ShardingStrategy,
+		Schema:               p.Schema,
 	}
 }
 
@@ -371,7 +374,8 @@ type setCollectionPropertiesOptionsInternal struct {
 	// Deprecated: use 'WriteConcern' instead
 	MinReplicationFactor int `json:"minReplicationFactor,omitempty"`
 	// Available from 3.6 arangod version.
-	WriteConcern int `json:"writeConcern,omitempty"`
+	WriteConcern int                      `json:"writeConcern,omitempty"`
+	Schema       *CollectionSchemaOptions `json:"schema,omitempty"`
 }
 
 func (p *SetCollectionPropertiesOptions) asInternal() setCollectionPropertiesOptionsInternal {
@@ -382,6 +386,7 @@ func (p *SetCollectionPropertiesOptions) asInternal() setCollectionPropertiesOpt
 		ReplicationFactor:    replicationFactor(p.ReplicationFactor),
 		MinReplicationFactor: p.MinReplicationFactor,
 		WriteConcern:         p.WriteConcern,
+		Schema:               p.Schema,
 	}
 }
 
@@ -392,6 +397,7 @@ func (p *SetCollectionPropertiesOptions) fromInternal(i *setCollectionProperties
 	p.ReplicationFactor = int(i.ReplicationFactor)
 	p.MinReplicationFactor = i.MinReplicationFactor
 	p.WriteConcern = i.WriteConcern
+	p.Schema = i.Schema
 }
 
 // MarshalJSON converts SetCollectionPropertiesOptions into json

database_collections.go

@@ -113,6 +113,8 @@ type CreateCollectionOptions struct {
 	// This attribute specifies the name of the sharding strategy to use for the collection.
 	// Must be one of ShardingStrategy* values.
 	ShardingStrategy ShardingStrategy `json:"shardingStrategy,omitempty"`
+	// Schema for collection validation
+	Schema *CollectionSchemaOptions `json:"schema,omitempty"`
 }
 
 // CollectionType is the type of a collection.

database_collections_impl.go

@@ -106,23 +106,24 @@ type createCollectionOptionsInternal struct {
 	ReplicationFactor replicationFactor `json:"replicationFactor,omitempty"`
 	CacheEnabled      *bool             `json:"cacheEnabled,omitempty"`
 	// Deprecated: use 'WriteConcern' instead
-	MinReplicationFactor int                   `json:"minReplicationFactor,omitempty"`
-	WriteConcern         int                   `json:"writeConcern,omitempty"`
-	WaitForSync          bool                  `json:"waitForSync,omitempty"`
-	DoCompact            *bool                 `json:"doCompact,omitempty"`
-	IsVolatile           bool                  `json:"isVolatile,omitempty"`
-	ShardKeys            []string              `json:"shardKeys,omitempty"`
-	NumberOfShards       int                   `json:"numberOfShards,omitempty"`
-	IsSystem             bool                  `json:"isSystem,omitempty"`
-	Type                 CollectionType        `json:"type,omitempty"`
-	IndexBuckets         int                   `json:"indexBuckets,omitempty"`
-	KeyOptions           *CollectionKeyOptions `json:"keyOptions,omitempty"`
-	DistributeShardsLike string                `json:"distributeShardsLike,omitempty"`
-	IsSmart              bool                  `json:"isSmart,omitempty"`
-	SmartGraphAttribute  string                `json:"smartGraphAttribute,omitempty"`
-	Name                 string                `json:"name"`
-	SmartJoinAttribute   string                `json:"smartJoinAttribute,omitempty"`
-	ShardingStrategy     ShardingStrategy      `json:"shardingStrategy,omitempty"`
+	MinReplicationFactor int                      `json:"minReplicationFactor,omitempty"`
+	WriteConcern         int                      `json:"writeConcern,omitempty"`
+	WaitForSync          bool                     `json:"waitForSync,omitempty"`
+	DoCompact            *bool                    `json:"doCompact,omitempty"`
+	IsVolatile           bool                     `json:"isVolatile,omitempty"`
+	ShardKeys            []string                 `json:"shardKeys,omitempty"`
+	NumberOfShards       int                      `json:"numberOfShards,omitempty"`
+	IsSystem             bool                     `json:"isSystem,omitempty"`
+	Type                 CollectionType           `json:"type,omitempty"`
+	IndexBuckets         int                      `json:"indexBuckets,omitempty"`
+	KeyOptions           *CollectionKeyOptions    `json:"keyOptions,omitempty"`
+	DistributeShardsLike string                   `json:"distributeShardsLike,omitempty"`
+	IsSmart              bool                     `json:"isSmart,omitempty"`
+	SmartGraphAttribute  string                   `json:"smartGraphAttribute,omitempty"`
+	Name                 string                   `json:"name"`
+	SmartJoinAttribute   string                   `json:"smartJoinAttribute,omitempty"`
+	ShardingStrategy     ShardingStrategy         `json:"shardingStrategy,omitempty"`
+	Schema               *CollectionSchemaOptions `json:"schema,omitempty"`
 }
 
 // CreateCollection creates a new collection with given name and options, and opens a connection to it.
@@ -195,6 +196,7 @@ func (p *createCollectionOptionsInternal) fromExternal(i *CreateCollectionOption
 	p.SmartGraphAttribute = i.SmartGraphAttribute
 	p.SmartJoinAttribute = i.SmartJoinAttribute
 	p.ShardingStrategy = i.ShardingStrategy
+	p.Schema = i.Schema
 }
 
 // // MarshalJSON converts CreateCollectionOptions into json

database_collections_schema.go

@@ -0,0 +1,53 @@
+//
+// DISCLAIMER
+//
+// Copyright 2020 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Adam Janikowski
+//
+
+package driver
+
+import (
+	"encoding/json"
+)
+
+type CollectionSchemaLevel string
+
+const (
+	CollectionSchemaLevelNone     CollectionSchemaLevel = "none"
+	CollectionSchemaLevelNew      CollectionSchemaLevel = "new"
+	CollectionSchemaLevelModerate CollectionSchemaLevel = "moderate"
+	CollectionSchemaLevelStrict   CollectionSchemaLevel = "strict"
+)
+
+type CollectionSchemaOptions struct {
+	Rule    interface{}           `json:"rule,omitempty"`
+	Level   CollectionSchemaLevel `json:"level,omitempty"`
+	Message string                `json:"message,omitempty"`
+}
+
+func (d *CollectionSchemaOptions) LoadRule(data []byte) error {
+	var rule interface{}
+
+	if err := json.Unmarshal(data, &rule); err != nil {
+		return err
+	}
+
+	d.Rule = rule
+	return nil
+}

go.mod

@@ -9,9 +9,9 @@ require (
 	github.com/dchest/uniuri v0.0.0-20160212164326-8902c56451e9
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible
 	github.com/google/uuid v1.1.1
-	github.com/kr/pretty v0.1.0 // indirect
+	github.com/kr/pretty v0.2.0 // indirect
 	github.com/pkg/errors v0.8.1
 	github.com/stretchr/testify v1.5.1
-	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
+	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
 	gopkg.in/yaml.v2 v2.2.8 // indirect
 )

go.sum

@@ -12,8 +12,8 @@ github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumC
 github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
 github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY=
 github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
-github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/kr/pretty v0.2.0 h1:s5hAObm+yFO5uHYt5dYjxi2rXrsnmRpJx4OYvIWUaQs=
+github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
@@ -26,8 +26,8 @@ github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
-gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
+gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=