README.md

CosmosDB GO sdk

• Installation
• Usage
  • Documents
  • Collections
  • Databases
  • StoredProcedures
  • UDFs
  • Triggers
  • Query Builder

Installation

• go get github.com/spacycoder/cosmosdb-go-sdk/cosmos

Usage

To get started import the cosmos package and create a client.

import github.com/SpacyCoder/cosmosdb-go-sdk/cosmos

client, err := cosmos.New("YOUR_CONNECTION_STRING")

Documents

Create Document

note: If your don't supply an id for the document it will be automatically created for you

type Person struct {
    cosmos.DocumentDefinition
    Name string `json:"name"`
    Age string `json:"age"`
}

func main() {
    client, err := cosmos.New("YOUR_CONNECTION_STRING")
    newPerson := &Person{
        Name: "Todd",
        Age: 99
    }
    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    res, err := client.Database("dbID").Collection("CollectionID").Documents(newPerson).Create(ctx)
}

Read Document

type Person struct {
    cosmos.DocumentDefinition
    Name string `json:"name"`
    Age string `json:"age"`
}

func main() {
    client, err := cosmos.New("YOUR_CONNECTION_STRING")
    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    var person Person
    res, err := client.Database("dbID").Collection("CollectionID").Document("docID").Read(ctx, &person, cosmos.PartitionKey(99))
}

List Documents

type Person struct {
    cosmos.DocumentDefinition
    Name string `json:"name"`
    Age string `json:"age"`
}

func main() {
    client, err := cosmos.New("YOUR_CONNECTION_STRING")
    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    var people []Person
    res, err := client.Database("dbID").Collection("CollectionID").Documents().ReadAll(ctx, &people, cosmos.CrossPartition())
}

Query Documents

type Person struct {
    cosmos.DocumentDefinition
    Name string `json:"name"`
    Age string `json:"age"`
}

func main() {
    client, err := cosmos.New("YOUR_CONNECTION_STRING")
    db := client.Database("dbID")
    coll := db.Collection("CollectionID")
    var people []Person
    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    params := []cosmos.P{{Name: "@LENGTH", Value: 180},{Name: "@AGE", Value: 30}}
    query := cosmos.Q("SELECT * FROM root WHERE root.length < @LENGTH AND  root.age > @AGE", params...)
    res, err := coll.Documents().Query(ctx, query, &people, cosmos.CrossPartition())
}

or with query builder

import ("github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"
 "github.com/SpacyCoder/cosmosdb-go-sdk/qbuilder")

type Person struct {
    cosmos.DocumentDefinition
    Name string `json:"name"`
    Age string `json:"age"`
}

func main() {
    client, err := cosmos.New("YOUR_CONNECTION_STRING")
    db := client.Database("dbID")
    coll := db.Collection("CollectionID")

    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    var people []Person
    params := []cosmos.P{{Name: "@LENGTH", Value: 180},{Name: "@AGE", Value: 30}}
    qb := qbuilder.New()
    query := qb.Select("*").From("root").And("root.length < @LENGTH").And("root.age > @AGE").Params(params...).Build()
    res, err := coll.Documents().Query(ctx, query, &people, cosmos.CrossPartition())
}

Delete Document

import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

func main() {
    client, err := cosmos.New("YOUR_CONNECTION_STRING")
    db := client.Database("dbID")
    coll := db.Collection("CollectionID")

    res, err := coll.Document("docID").Delete(cosmos.PartitionKey("partitionKey"))
}

Collection

Create collection

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        db := client.Database("dbID")
	    newCollDef := &cosmos.CollectionDefinition{
	    	IndexingPolicy: cosmos.IndexingPolicy{IndexingMode: "consistent"},
	    	Resource:       cosmos.Resource{ID: collID},
            PartitionKey:   cosmos.PartitionKeyDefinition{Kind: "hash", Paths: []string{"/name"}
            }
        }

        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        _, err := db.Collections().Create(ctx, newCollDef)
    }

Read Collection

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        db := client.Database("dbID")

        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        collDef, err := db.Collection("collID").Read(ctx)
    }

List Collections

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        db := client.Database("dbID")

        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        collDefs, err :=  db.Collections().ReadAll(ctx)
    }

Delete Collection

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        db := client.Database("dbID")

        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        res, err :=  db.Collection("collID").Delete(ctx)
    }

Databases

Create Database

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        dbDef, err := client.Databases().Create(ctx, "DATABASE_ID")
    }

Read Database

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        dbDef, err := client.Database(ctx, "DATABASE_ID").Read()
    }

List Databases

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        dbDefs, err = client.Databases().ReadAll(ctx)
    }

Delete Database

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        _, err = client.Database(dbID).Delete(ctx)
    }

StoredProcedures

Create Stored Procedure

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        coll := client.Database("dbID").Collection("collID")
        spDef := &cosmos.StoredProcedureDefinition{
            Resource: cosmos.Resource{ID: "mySP"},
            Body: "function () {\r\n var context = getContext();\r\n var response = context.getResponse();\r\n\r\n  response.setBody(\"Hello, World\");\r\n}"
        }

        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        createdSP, err := coll.StoredProcedures().Create(ctx, spDef)
    }

Execute Stored Procedure

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

     func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        coll := client.Database("dbID").Collection("collID")
        var res string
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        _, err = coll.StoredProcedure("mySP").Execute(ctx, "", &res)
    }

Replace Stored Procedure

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

     func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        coll := client.Database("dbID").Collection("collID")
        newSpDef := &cosmos.StoredProcedureDefinition{
            Resource: cosmos.Resource{ID: "mySP"},
            Body: "function (greet, someone) {\r\n var context = getContext();\r\n var response = context.getResponse();\r\n\r\n response.setBody(greet + \", \"+ someone);\r\n}"
        }

        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        _, err = coll.StoredProcedure("mySP").Replace(ctx, newSpDef)
    }

List Stored Procedures

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        coll := client.Database("dbID").Collection("collID")
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        sprocs, err := coll.StoredProcedures().ReadAll(ctx)
    }

Delete Stored Procedure

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        _, err = coll.StoredProcedure("mySP").Delete(ctx)
    }

UDFs

Create UDF

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        coll := client.Database("dbID").Collection("collID")
        udfDef := &cosmos.UDFDefinition{
		    Body: "function tax(income) {\r\n if(income == undefined) \r\n throw 'no input';\r\n if (income < 1000) \r\n return income * 0.1;\r\n else if (income < 10000) \r\n return income * 0.2;\r\n else\r\n return income * 0.4;\r\n}",
            Resource: cosmos.Resource{ID: "myUDF"},
        }
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        createdUDF, err := coll.UDFs().Create(ctx, udfDef)
    }

Replace UDF

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        coll := client.Database("dbID").Collection("collID")
        newUDF := &cosmos.UDFDefinition{
		    Body: "function tax(income) {\r\n if(income == undefined) \r\n throw 'no input';\r\n if (income     < 2000) \r\n return income * 0.1;\r\n else if (income < 10000) \r\n return income * 0.2;\r\n    else\r\n return income * 0.4;\r\n}",
            Resource: cosmos.Resource{ID: "myUDF"},
        }
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        updatedUDF, err := coll.UDF("myUDF").Replace(ctx, newUDF)
    }

List UDFs

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        coll := client.Database("dbID").Collection("collID")
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        udfs, err := coll.UDFs().ReadAll(ctx)
    }

Delete UDF

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        _, err = coll.UDF("myUDF").Delete(ctx)
    }

Triggers

Create Trigger

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        coll := client.Database("dbID").Collection("collID")
        triggerDef := &cosmos.TriggerDefintion{
		    Body: "function updateMetadata() {\r\n  var context = getContext();\r\nvar collection = context.getCollection   ();\r\nvar response = context.getResponse();\r\nvar createdDocument = response.getBody();\r\n\r\n// query for metadata     document\r\nvar filterQuery = 'SELECT * FROM root r WHERE r.id = \"_metadata\"';\r\nvar accept = collection.queryDocuments  (collection.getSelfLink(), filterQuery,\r\n  updateMetadataCallback);\r\n    if(!accept) throw \"Unable to update metadata, abort\";\r\n\r\nfunction updateMetadataCallback(err, documents, responseOptions) {\r\n  if(err) throw new Error (\"Error\" + err.message);\r\n   if(documents.length != 1) throw 'Unable to find metadata document';\r\n   var metadataDocument = documents[0];\r\n\r\n   // update metadata\r\n   metadataDocument.createdDocuments += 1;\r\n     metadataDocument.createdNames += \" \" + createdDocument.id;\r\nvar accept = collection.replaceDocument (metadataDocument._self,\r\n metadataDocument, function(err, docReplaced) {\r\n       if(err) throw \"Unable to update  metadata, abort\";\r\n });\r\nif(!accept) throw \"Unable to update metadata, abort\";\r\nreturn;\r\n    }",
		    Resource:         cosmos.Resource{ID: "myTrigger"},
		    TriggerOperation: "All",
            TriggerType:      "Post",
        }
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        _, err := coll.Triggers().Create(ctx, triggerDef)
    }

Replace Trigger

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        coll := client.Database("dbID").Collection("collID")
        newTriggerDef := &cosmos.TriggerDefintion{
		    Body: "function updateMetadata() {\r\n  var context = getContext();\r\nvar collection = context.getCollection   ();\r\nvar response = context.getResponse();\r\nvar createdDocument = response.getBody();\r\n\r\n// query for metadata     document\r\nvar filterQuery = 'SELECT * FROM root r WHERE r.id = \"_metadata\"';\r\nvar accept = collection.queryDocuments  (collection.getSelfLink(), filterQuery,\r\n  updateMetadataCallback);\r\n    if(!accept) throw \"Unable to update     metadata, exit\";\r\n\r\nfunction updateMetadataCallback(err, documents, responseOptions) {\r\n  if(err) throw new Error    (\"Error\" + err.message);\r\n   if(documents.length != 1) throw 'Unable to find metadata document';\r\n   var  metadataDocument = documents[0];\r\n\r\n   // update metadata\r\n   metadataDocument.createdDocuments += 1;\r\n      metadataDocument.createdNames += \" \" + createdDocument.id;\r\nvar accept = collection.replaceDocument    (metadataDocument._self,\r\n    metadataDocument, function(err, docReplaced) {\r\n       if(err) throw \"Unable to update   metadata, abort\";\r\n    });\r\nif(!accept) throw \"Unable to update metadata, abort\";\r\nreturn;\r\n    }",
		    Resource:         cosmos.Resource{ID: "myTrigger"},
		    TriggerOperation: "All",
            TriggerType:      "Post",
        }
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        updatedTriggerDef, err := coll.Trigger("myTrigger").Replace(ctx, newTriggerDef)
    }

List Triggers

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        coll := client.Database("dbID").Collection("collID")
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        triggers, err := coll.Triggers().ReadAll(ctx)
    }

Delete Trigger

    import "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"

    func main() {
        client, err := cosmos.New("YOUR_CONNECTION_STRING")
        ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        _, err = coll.Trigger("myTrigger").Delete(ctx)
    }

QueryBuilder

CosmosDB sdk for go includes a simple query builder.

supports:

• AND
• OR
• SELECT
• FROM
• ORDER BY

Example 1

import (
    "github.com/SpacyCoder/cosmosdb-go-sdk/qbuilder"
    "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"
)

func main()  {
    client, err := cosmos.New("YOUR_CONNECTION_STRING")

    qb := qbuilder.New()
    query := qb.Select("*").From("root").And("root.age > 10").Build()
    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)

    var people []People
    client.Database("mydb").Collection("people").Documents().Query(ctx, query, people, Cosmos.CrossPartition())
}

Example 2

import (
    "github.com/SpacyCoder/cosmosdb-go-sdk/qbuilder"
    "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"
)

func main()  {
    client, err := cosmos.New("YOUR_CONNECTION_STRING")
import "github.com/SpacyCoder/cosmosdb-go-sdk/qbuilder"
 "github.com/SpacyCoder/cosmosdb-go-sdk/cosmos"
    qb := qbuilder.New()
    q1 := qb.Select("*").From("root").And("root.age > @AGE").And("root.height > @HEIGHT").OrderBy("DESC root.height")
    query := q1.Params(cosmos.P{Name: "@AGE", Value: 20}, cosmos.P{Name: "@HEIGHT", Value: 180}).Build()

    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    var people []People
    client.Database("mydb").Collection("people").Documents().Query(ctx, query, people, Cosmos.CrossPartition())
}