Documentation ¶
Overview ¶
package cosmos_db_restapi Golang Package for the cosmos db rest api
Index ¶
- func CreateDocument(endpoint_uri string, master_key string, database string, container string, ...) (Status string, Body string)
- func DeleteDocumentByID(endpoint_uri string, master_key string, database string, container string, ...) (Status string, Body string)
- func ExecuteQuerry(endpoint_uri string, master_key string, database string, container string, ...) (Status string, Body string, Continuation string)
- func GetAuthorizationTokenUsingMasterKey(verb string, resourceType string, resourceId string, date string, ...) string
- func GetDocumentByID(endpoint_uri string, master_key string, database string, container string, ...) (Status string, Body string)
- type TBody
- type TContainer
- func (me *TContainer) CreateDocument(upset bool, data string) (Status string, Body string)
- func (me *TContainer) DeleteDocumentByID(id string) (Status string, Body string)
- func (me *TContainer) ExecuteQuerry(max_item_count int, continuation string, query TQuerry) (Status string, Body string, Continuation string)
- func (me *TContainer) Fetch() (Status string, Body string)
- func (me *TContainer) OpenQuerry(max_item_count int, query TQuerry)
- type TDatabase
- type TParameter
- type TQuerry
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateDocument ¶
func DeleteDocumentByID ¶
func DeleteDocumentByID(endpoint_uri string, master_key string, database string, container string, partitionkey string, id string) (Status string, Body string)
DeleteDocumentByID - delete an object by ID via rest api
parameters:
endpoint_uri - uri from cosmos db master_key - master key from cosmos db database - name of database container - name of container partitionkey - optional partition (if container defined with partion key, it is required) id - id of the item
returns:
Status - response status i.e. 204 No Content Body - response body as string i.e. ""
func ExecuteQuerry ¶
func ExecuteQuerry(endpoint_uri string, master_key string, database string, container string, partitionkey string, max_item_count int, continuation string, query TQuerry) (Status string, Body string, Continuation string)
ExecuteQuerry - execute a query as rest api
parameters:
endpoint_uri - uri from cosmos db master_key - master key from cosmos db database - name of database container - name of container partitionkey - optional partition key else "" max_item_count - optional max item count else 0 querry - like TQuerry
returns:
Status - response status i.e. 200 ok Body - response body as string Continuation - the Continuation-token if there are more items to read
func GetAuthorizationTokenUsingMasterKey ¶
func GetAuthorizationTokenUsingMasterKey( verb string, resourceType string, resourceId string, date string, masterKey string) string
GetAuthorizationTokenUsingMasterKey function for generating access token
https://docs.microsoft.com/en-us/rest/api/cosmos-db/access-control-on-cosmosdb-resources
func GetDocumentByID ¶
func GetDocumentByID(endpoint_uri string, master_key string, database string, container string, partitionkey string, id string) (Status string, Body string)
GetDocumentByID - get an object by ID via rest api
parameters:
endpoint_uri - uri from cosmos db master_key - master key from cosmos db database - name of database container - name of container partitionkey - optional partition (if container defined with partion key, it is required) id - id of the item
returns:
Status - response status i.e. 200 ok Body - response body as string
Types ¶
type TContainer ¶ added in v0.1.1
type TContainer struct { Database TDatabase `json:"database"` Container string `json:"container"` PartitionKey string `json:"partition_key"` Query TQuerry `json:"query"` MaxItemCount int `json:"max_item_count"` Continuation string `json:"continuation"` Steps int `json:"steps"` Status string `json:"status"` Body string `json:"body"` }
TContainer - Object for accessing a container
func ContainerFactory ¶ added in v0.1.1
func ContainerFactory(database TDatabase, container string, partitionkey string) TContainer
ContainerFactory - creates a container object
func (*TContainer) CreateDocument ¶ added in v0.1.1
func (me *TContainer) CreateDocument(upset bool, data string) (Status string, Body string)
func (*TContainer) DeleteDocumentByID ¶ added in v0.1.1
func (me *TContainer) DeleteDocumentByID(id string) (Status string, Body string)
func (*TContainer) ExecuteQuerry ¶ added in v0.1.1
func (*TContainer) Fetch ¶ added in v0.1.1
func (me *TContainer) Fetch() (Status string, Body string)
Fetch - a fetch leads to a query
func (*TContainer) OpenQuerry ¶ added in v0.1.1
func (me *TContainer) OpenQuerry(max_item_count int, query TQuerry)
OpenQuerry - defines a query for execution in fetch mode
type TDatabase ¶ added in v0.1.1
type TDatabase struct { EndpointUri string `json:"endpoint_uri"` MasterKey string `json:"master_key"` Database string `json:"database"` }
TDatabase - Structure for the access of the server and the database
type TParameter ¶
TQuerry structure for querry call:
{ "query":"SELECT * FROM c WHERE c.name = @name", "parameters": [{ "name": "@name", "value": "Julian" }] }
type TQuerry ¶
type TQuerry struct { Query string `json:"query"` Parameters []TParameter `json:"parameters"` }