forked from ravendb/ravendb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
IAsyncDocumentSession.cs
111 lines (96 loc) · 3.41 KB
/
IAsyncDocumentSession.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
//-----------------------------------------------------------------------
// <copyright file="IAsyncDocumentSession.cs" company="Hibernating Rhinos LTD">
// Copyright (c) Hibernating Rhinos LTD. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
#if !NET_3_5
using System;
using System.Linq.Expressions;
using System.Threading.Tasks;
using Raven.Client.Document;
namespace Raven.Client
{
using Linq;
/// <summary>
/// Interface for document session using async approaches
/// </summary>
public interface IAsyncDocumentSession : IDisposable
{
/// <summary>
/// Get the accessor for advanced operations
/// </summary>
/// <remarks>
/// Those operations are rarely needed, and have been moved to a separate
/// property to avoid cluttering the API
/// </remarks>
IAsyncAdvancedSessionOperations Advanced { get; }
/// <summary>
/// Begin a load while including the specified path
/// </summary>
/// <param name="path">The path.</param>
IAsyncLoaderWithInclude<object> Include(string path);
/// <summary>
/// Begin a load while including the specified path
/// </summary>
/// <param name="path">The path.</param>
IAsyncLoaderWithInclude<T> Include<T>(Expression<Func<T, object>> path);
/// <summary>
/// Stores the specified entity with the specified etag.
/// The entity will be saved when <see cref="SaveChangesAsync"/> is called.
/// </summary>
void Store(object entity, Guid etag);
/// <summary>
/// Stores the specified entity in the session. The entity will be saved when <see cref="SaveChangesAsync"/> is called.
/// </summary>
/// <param name="entity">The entity.</param>
void Store(object entity);
/// <summary>
/// Marks the specified entity for deletion. The entity will be deleted when <see cref="IDocumentSession.SaveChanges"/> is called.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="entity">The entity.</param>
void Delete<T>(T entity);
/// <summary>
/// Begins the async load operation
/// </summary>
/// <param name="id">The id.</param>
/// <returns></returns>
Task<T> LoadAsync<T>(string id);
/// <summary>
/// Loads the specified entities with the specified id after applying
/// conventions on the provided id to get the real document id.
/// </summary>
/// <remarks>
/// This method allows you to call:
/// Load{Post}(1)
/// And that call will internally be translated to
/// Load{Post}("posts/1");
///
/// Or whatever your conventions specify.
/// </remarks>
Task<T> LoadAsync<T>(ValueType id);
/// <summary>
/// Begins the async multi load operation
/// </summary>
/// <param name="ids">The ids.</param>
/// <returns></returns>
Task<T[]> LoadAsync<T>(string[] ids);
/// <summary>
/// Begins the async save changes operation
/// </summary>
/// <returns></returns>
Task SaveChangesAsync();
/// <summary>
/// Queries the specified index using Linq.
/// </summary>
/// <typeparam name="T">The result of the query</typeparam>
/// <param name="indexName">Name of the index.</param>
IRavenQueryable<T> Query<T>(string indexName);
/// <summary>
/// Dynamically queries RavenDB using LINQ
/// </summary>
/// <typeparam name="T">The result of the query</typeparam>
IRavenQueryable<T> Query<T>();
}
}
#endif