Skip to content

Added Sql Stored Procedure for CosmosDB #6659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MehaKaushik wants to merge 8 commits into from
Closed

Added Sql Stored Procedure for CosmosDB #6659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7198c7d
adding stored procedures in cosmos-db.json
Jul 17, 2019
331b75e
fixed a typo
Jul 17, 2019
a0d488e
example files for stored procedures
Jul 17, 2019
42a3078
changes in readme
Jul 17, 2019
82ff450
fixed a typo
Jul 18, 2019
488a195
renamed Body to body in example json files
Jul 18, 2019
21a3e47
renamed storedprocedures to storedProcedures in example files
Jul 18, 2019
41d23b9
renamed storedprocedures to storedProcedures in cosmos-db.json
Jul 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
273 changes: 273 additions & 0 deletions ...fication/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1935,6 +1935,184 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/sql/databases/{databaseName}/containers/{containerName}/storedProcedures": {
"get": {
"operationId": "DatabaseAccounts_ListSqlStoredProcedures",
"x-ms-examples": {
"CosmosDBSqlStoredProcedureList": {
"$ref": "./examples/CosmosDBSqlStoredProcedureList.json"
}
},
"description": "Lists the SQL stored procedures under an existing Azure Cosmos DB database account.",
"parameters": [
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/accountNameParameter"
},
{
"$ref": "#/parameters/databaseNameParameter"
},
{
"$ref": "#/parameters/containerNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "The SQL stored procedure properties were retrieved successfully.",
"schema": {
"$ref": "#/definitions/SqlStoredProcedureListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": null
Copy link
Member

@anthony-c-martin anthony-c-martin Jul 22, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're not supporting paging, do you have any limits on the number of stored procedures that can be created? How big can this response get?

Copy link
Contributor Author

@MehaKaushik MehaKaushik Jul 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We support paging internally in CosmosDB. Hence, paging is not required here.

}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/sql/databases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}": {
"get": {
"operationId": "DatabaseAccounts_GetSqlStoredProcedure",
"x-ms-examples": {
"CosmosDBSqlStoredProcedureGet": {
"$ref": "./examples/CosmosDBSqlStoredProcedureGet.json"
}
},
"description": "Gets the SQL StoredProcedure under an existing Azure Cosmos DB database account.",
"parameters": [
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/accountNameParameter"
},
{
"$ref": "#/parameters/databaseNameParameter"
},
{
"$ref": "#/parameters/containerNameParameter"
},
{
"$ref": "#/parameters/storedProcedureNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "The SQL StoredProcedure property was retrieved successfully.",
"schema": {
"$ref": "#/definitions/SqlStoredProcedure"
}
}
}
},
"put": {
"operationId": "DatabaseAccounts_CreateUpdateSqlStoredProcedure",
"x-ms-examples": {
"CosmosDBSqlStoredProcedureCreateUpdate": {
"$ref": "./examples/CosmosDBSqlStoredProcedureCreateUpdate.json"
}
},
"description": "Create or update an Azure Cosmos DB SQL StoredProcedure",
"x-ms-long-running-operation": true,
"parameters": [
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/accountNameParameter"
},
{
"$ref": "#/parameters/databaseNameParameter"
},
{
"$ref": "#/parameters/containerNameParameter"
},
{
"$ref": "#/parameters/storedProcedureNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"name": "createUpdateSqlStoredProcedureParameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/SqlStoredProcedureCreateUpdateParameters"
},
"description": "The parameters to provide for the current SQL StoredProcedure."
}
],
"responses": {
"202": {
"description": "The SQL StoredProcedure create or update operation will complete asynchronously."
},
"200": {
"description": "The SQL StoredProcedure create or update operation was completed successfully.",
"schema": {
"$ref": "#/definitions/SqlStoredProcedure"
}
}
}
},
"delete": {
"operationId": "DatabaseAccounts_DeleteSqlStoredProcedure",
"x-ms-examples": {
"CosmosDBSqlStoredProcedureDelete": {
"$ref": "./examples/CosmosDBSqlStoredProcedureDelete.json"
}
},
"description": "Deletes an existing Azure Cosmos DB SQL StoredProcedure.",
"x-ms-long-running-operation": true,
"parameters": [
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/accountNameParameter"
},
{
"$ref": "#/parameters/databaseNameParameter"
},
{
"$ref": "#/parameters/containerNameParameter"
},
{
"$ref": "#/parameters/storedProcedureNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"202": {
"description": "The SQL stored procedure delete operation will complete asynchronously."
},
"204": {
"description": "The SQL stored procedure delete operation was completed successfully."
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/mongodb/databases": {
"get": {
"operationId": "DatabaseAccounts_ListMongoDBDatabases",
Expand Down Expand Up @@ -3689,6 +3867,19 @@
},
"description": "The List operation response, that contains the containers and their properties."
},
"SqlStoredProcedureListResult": {
"properties": {
"value": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "#/definitions/SqlStoredProcedure"
},
"description": "List of stored procedures and their properties."
}
},
"description": "The List operation response, that contains the stored procedures and their properties."
},
"MongoDBDatabaseListResult": {
"properties": {
"value": {
Expand Down Expand Up @@ -4040,6 +4231,34 @@
}
]
},
"SqlStoredProcedure": {
"description": "An Azure Cosmos DB stored procedure.",
"type": "object",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"description": "The properties of an Azure Cosmos DB stored procedure",
"$ref": "#/definitions/SqlStoredProcedureProperties"
}
},
"allOf": [
{
"$ref": "#/definitions/Resource"
}
]
},
"SqlStoredProcedureProperties": {
"description": "The properties of an Azure Cosmos DB stored procedure",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SqlStoredProcedureResource"
},
{
"$ref": "#/definitions/ExtendedResourceProperties"
}
]
},
"MongoDBDatabase": {
"description": "An Azure Cosmos DB MongoDB database.",
"type": "object",
Expand Down Expand Up @@ -4661,6 +4880,38 @@
"options"
]
},
"SqlStoredProcedureCreateUpdateParameters": {
"description": "Parameters to create and update Cosmos DB stored procedure.",
"type": "object",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"description": "Properties to create and update Azure Cosmos DB stored procedure.",
"$ref": "#/definitions/SqlStoredProcedureCreateUpdateProperties"
}
},
"required": [
"properties"
]
},
"SqlStoredProcedureCreateUpdateProperties": {
"description": "Properties to create and update Azure Cosmos DB stored procedure.",
"type": "object",
"properties": {
"resource": {
"description": "The standard JSON format of a stored procedure",
"$ref": "#/definitions/SqlStoredProcedureResource"
},
"options": {
"description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.",
"$ref": "#/definitions/CreateUpdateOptions"
}
},
"required": [
"resource",
"options"
]
},
"MongoDBDatabaseCreateUpdateParameters": {
"description": "Parameters to create and update Cosmos DB MongoDB database.",
"type": "object",
Expand Down Expand Up @@ -4944,6 +5195,20 @@
"id"
]
},
"SqlStoredProcedureResource": {
Copy link
Member

@anthony-c-martin anthony-c-martin Jul 22, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Calling this a "resource" with an "id" property could make things confusing, as this isn't an Azure resource. Please could you update the naming to avoid confusion?

"type": "object",
"description": "Cosmos DB Gremlin graph resource object",
"properties": {
"id":{
"type":"string",
"description":"Name of the Sql Stored Procedure"
},
"body":{
"type": "string",
"description": "Body of the Stored Procedure"
}
}
},
"GremlinGraphResource": {
"type": "object",
"description": "Cosmos DB Gremlin graph resource object",
Expand Down Expand Up @@ -5982,6 +6247,14 @@
"x-ms-parameter-location": "method",
"description": "Cosmos DB container name."
},
"storedProcedureNameParameter":{
"name": "storedProcedureName",
"in": "path",
"required": true,
"type": "string",
"x-ms-parameter-location": "method",
"description": "Cosmos DB SQL StoredProcedure name"
},
"tableNameParameter": {
"name": "tableName",
"in": "path",
Expand Down
37 changes: 37 additions & 0 deletions ...crosoft.DocumentDB/stable/2015-04-08/examples/CosmosDBSqlStoredProcedureCreateUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"parameters": {
"accountName": "ddb1",
"resourceGroupName": "rg1",
"api-version": "2015-04-08",
"subscriptionId": "subid",
"databaseName": "databaseName",
"containerName": "containerName",
"storedProcedureName": "storedProcedureName",
"createUpdateSqlStoredProcedureParameters": {
"properties": {
Copy link
Member

@anthony-c-martin anthony-c-martin Jul 22, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't appear to adhere to the expectations around resource CRUD - you're missing "id", "name" and "type" properties, and the shape of the properties on the PUT doesn't match the shape of the properties on the response.

"resource": {
"id": "storedProcedureName",
"body": "body"
},
"options": {}
}
}
},
"responses": {
"200": {
"body": {
"id": "storedProcedureName",
Copy link
Member

@anthony-c-martin anthony-c-martin Jul 22, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please format the "id" correctly

"name": "storedProcedureName",
"type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/storedProcedures",
"properties": {
"id": "storedProcedureName",
"body": "body",
"_rid": "PD5DALigDgw=",
"_ts": 1459200611,
"_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
}
}
},
"202": {}
}
}
15 changes: 15 additions & 0 deletions ...ger/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBSqlStoredProcedureDelete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"parameters": {
"accountName": "ddb1",
"resourceGroupName": "rg1",
"api-version": "2015-04-08",
"subscriptionId": "subid",
"databaseName": "databaseName",
"containerName": "containerName",
"storedProcedureName": "storedProcedureName"
},
"responses": {
"204": {},
"202": {}
}
}
27 changes: 27 additions & 0 deletions ...anager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBSqlStoredProcedureGet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"parameters": {
"api-version": "2015-04-08",
"subscriptionId": "subid",
"resourceGroupName": "rgName",
"accountName": "ddb1",
"databaseName": "databaseName",
"containerName": "containerName",
"storedProcedureName": "storedProcedureName"
},
"responses": {
"200": {
"body": {
"id": "storedProcedureName",
"name": "storedProcedureName",
"type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
"properties": {
"id": "storedProcedureName",
"body": "body",
"_rid": "PD5DALigDgw=",
"_ts": 1459200611,
"_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
}
}
}
}
}
Loading