Partition key validation on CreateContainerIfNotExistsAsync and code documentation update #572
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
j82w
reviewed
Jul 18, 2019
j82w
reviewed
Jul 22, 2019
j82w
previously approved these changes
Jul 24, 2019
| /// <para>Check if a database exists, and if it doesn't, create it. | ||
| /// Only the database id is used to verify if there is an existing database. Other database properties such as throughput are not validated and can be different then the passed properties.</para> | ||
| /// | ||
| /// Status code 201: New database is created. |
There was a problem hiding this comment.
/// <returns>
/// A <see cref="Task"/> containing a <see cref="DatabaseResponse"/> which wraps a <see cref="DatabaseProperties"/> containing the read resource record.
/// </returns>
/// <exception cref="CosmosException">This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are:
/// <list>
/// <listheader>
/// <term>StatusCode</term><description>Reason for exception</description>
/// </listheader>
/// <item>
/// <term>404</term><description>NotFound - This means the resource you tried to read did not exist.</description>
/// </item>
/// <item>
/// <term>429</term><description>TooManyRequests - This means you have exceeded the number of request units per second.</description>
/// </item>
/// </list>
There was a problem hiding this comment.
StatusCode representation consistency with other places
There was a problem hiding this comment.
404 is not applicable in case of createifnotexist
There was a problem hiding this comment.
I pushed a new iteration using the list format for the status codes.
added 4 commits
July 24, 2019 15:03
…teApiDocumentUpdate
…ub.com/Azure/azure-cosmos-dotnet-v3 into users/nakumars/createApiDocumentUpdate
kirankumarkolli
approved these changes
Jul 25, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR will add the code for comparing partition key definition retrieved from server on CreateContainerIfNotExistsAsync api with the one provided by user and throw exception if they are not equal.
Also updating code documentation for CreateIfNotExistsAsync both for container and database.
Closing issues
closes #549