Skip to content
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.

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

Documentation: Update Database.ReadAsync description #3457

Merged
merged 24 commits into from
Mar 1, 2023
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
a06e2ab
Documentation: Modify retry time to timespan
SaurabhSharma-MSFT Jul 12, 2022
abea674
Merge branch 'master' into master
ealsur Jul 12, 2022
e3f25e0
Merge branch 'Azure:master' into master
SaurabhSharma-MSFT Jul 15, 2022
0d5493d
Documentation: Fixes DeleteItemAsync Example
SaurabhSharma-MSFT Jul 15, 2022
56011b1
Merge branch 'Azure:master' into master
SaurabhSharma-MSFT Aug 8, 2022
5a2416e
Documentation: Fixes ItemRequestOptions Example
SaurabhSharma-MSFT Aug 8, 2022
130789d
Merge branch 'master' into master
ealsur Aug 16, 2022
e9bc3d2
Merge branch 'master' into master
ealsur Aug 23, 2022
7a3734d
Merge branch 'Azure:master' into master
SaurabhSharma-MSFT Sep 13, 2022
8b3afb2
Documentation:Update Database.ReadAsync description
SaurabhSharma-MSFT Sep 13, 2022
88caaa0
Merge branch 'Azure:master' into master
SaurabhSharma-MSFT Sep 27, 2022
94c979e
Documentation: Update Database.ReadAsync description
SaurabhSharma-MSFT Sep 27, 2022
92d85bc
Documentation: Updated ToStreamIterator example
SaurabhSharma-MSFT Sep 27, 2022
2aff570
Modified StreamIterator section
SaurabhSharma-MSFT Sep 27, 2022
4e13dc0
Update Microsoft.Azure.Cosmos/src/Resource/Database/Database.cs
SaurabhSharma-MSFT Sep 30, 2022
b67cc33
Remarks correction
SaurabhSharma-MSFT Sep 30, 2022
4c68445
Merge branch 'master' into master
ealsur Sep 30, 2022
9f19fff
Merge branch 'master' into master
ealsur Oct 6, 2022
236dbf5
Merge branch 'master' into master
kirankumarkolli Nov 7, 2022
7e92a98
Revert the StreamIterator changes
SaurabhSharma-MSFT Dec 8, 2022
ffcdb5b
Merge branch 'master' into master
ealsur Dec 12, 2022
5dc78d5
Merge branch 'master' into master
ealsur Feb 16, 2023
48cf9b4
Merge branch 'master' into master
ealsur Feb 21, 2023
c1d5dc0
Merge branch 'master' into master
kirankumarkolli Mar 1, 2023
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
8 changes: 4 additions & 4 deletions Microsoft.Azure.Cosmos/src/Linq/CosmosLinqExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -174,19 +174,19 @@ public static FeedIterator<T> ToFeedIterator<T>(this IQueryable<T> query)
}

/// <summary>
/// This extension method gets the FeedIterator from LINQ IQueryable to execute query asynchronously.
/// This will create the fresh new FeedIterator when called.
/// This extension method gets the StreamIterator from LINQ IQueryable to execute query asynchronously.
ealsur marked this conversation as resolved.
Show resolved Hide resolved
/// This will create the fresh new StreamIterator when called.
/// </summary>
/// <typeparam name="T">the type of object to query.</typeparam>
/// <param name="query">the IQueryable{T} to be converted.</param>
/// <returns>An iterator to go through the items.</returns>
/// <example>
/// This example shows how to get FeedIterator from LINQ.
/// This example shows how to get StreamIterator from LINQ.
///
/// <code language="c#">
/// <![CDATA[
/// IOrderedQueryable<ToDoActivity> linqQueryable = this.Container.GetItemLinqQueryable<ToDoActivity>();
/// using (FeedIterator setIterator = linqQueryable.Where(item => (item.taskNum < 100)).ToFeedIterator()
/// using (FeedIterator setIterator = linqQueryable.Where(item => (item.taskNum < 100)).ToStreamIterator())
/// ]]>
/// </code>
/// </example>
Expand Down
7 changes: 5 additions & 2 deletions Microsoft.Azure.Cosmos/src/Resource/Database/Database.cs
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,18 @@ public abstract class Database
/// </summary>
public abstract CosmosClient Client { get; }

/// <summary>
/// Reads a <see cref="DatabaseProperties"/> from the Azure Cosmos service as an asynchronous operation.
/// <summary>
/// Reads a <see cref="DatabaseResponse"/> from the Azure Cosmos service as an asynchronous operation.
/// </summary>
/// <param name="requestOptions">(Optional) The options for the request.</param>
/// <param name="cancellationToken">(Optional) <see cref="CancellationToken"/> representing request cancellation.</param>
/// <returns>
/// A <see cref="Task"/> containing a <see cref="DatabaseResponse"/> which wraps a <see cref="DatabaseProperties"/> containing the read resource record.
/// </returns>
/// <exception>https://aka.ms/cosmosdb-dot-net-exceptions</exception>
/// <remarks>
/// <see cref="DatabaseResponse.Resource"/> contains the <see cref="DatabaseProperties"/> that include the resource information.
/// </remarks>
/// <example>
/// <code language="c#">
/// <![CDATA[
Expand Down