forked from ravendb/ravendb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
IDocumentStore.cs
145 lines (127 loc) · 4.17 KB
/
IDocumentStore.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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
//-----------------------------------------------------------------------
// <copyright file="IDocumentStore.cs" company="Hibernating Rhinos LTD">
// Copyright (c) Hibernating Rhinos LTD. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
using System;
#if !SILVERLIGHT
using System.Collections.Specialized;
#endif
using System.Collections.Generic;
using System.Net;
using Raven.Client.Connection;
using Raven.Client.Connection.Profiling;
using Raven.Client.Document;
#if SILVERLIGHT
using Raven.Client.Silverlight.Connection;
#endif
#if !NET_3_5
using Raven.Client.Connection.Async;
#endif
namespace Raven.Client
{
/// <summary>
/// Interface for managing access to RavenDB and open sessions.
/// </summary>
public interface IDocumentStore : IDisposalNotification
{
/// <summary>
/// Setup the context for aggressive caching.
/// </summary>
/// <param name="cahceDuration">Specify the aggressive cache duration</param>
/// <remarks>
/// Aggressive caching means that we will not check the server to see whatever the response
/// we provide is current or not, but will serve the information directly from the local cache
/// without touching the server.
/// </remarks>
IDisposable AggressivelyCacheFor(TimeSpan cahceDuration);
/// <summary>
/// Setup the context for no aggressive caching
/// </summary>
/// <remarks>
/// This is mainly useful for internal use inside RavenDB, when we are executing
/// queries that has been marked with WaitForNonStaleResults, we temporarily disable
/// aggressive caching.
/// </remarks>
IDisposable DisableAggressiveCaching();
/// <summary>
/// Gets the shared operations headers.
/// </summary>
/// <value>The shared operations headers.</value>
#if !SILVERLIGHT
NameValueCollection SharedOperationsHeaders { get; }
#else
IDictionary<string,string> SharedOperationsHeaders { get; }
#endif
/// <summary>
/// Get the <see cref="HttpJsonRequestFactory"/> for this store
/// </summary>
HttpJsonRequestFactory JsonRequestFactory { get; }
/// <summary>
/// Gets or sets the identifier for this store.
/// </summary>
/// <value>The identifier.</value>
string Identifier { get; set; }
/// <summary>
/// Initializes this instance.
/// </summary>
/// <returns></returns>
IDocumentStore Initialize();
#if !NET_3_5
/// <summary>
/// Gets the async database commands.
/// </summary>
/// <value>The async database commands.</value>
IAsyncDatabaseCommands AsyncDatabaseCommands { get; }
/// <summary>
/// Opens the async session.
/// </summary>
/// <returns></returns>
IAsyncDocumentSession OpenAsyncSession();
/// <summary>
/// Opens the async session.
/// </summary>
/// <returns></returns>
IAsyncDocumentSession OpenAsyncSession(string database);
#endif
#if !SILVERLIGHT
/// <summary>
/// Opens the session.
/// </summary>
/// <returns></returns>
IDocumentSession OpenSession();
/// <summary>
/// Opens the session for a particular database
/// </summary>
IDocumentSession OpenSession(string database);
/// <summary>
/// Opens the session for a particular database with the specified credentials
/// </summary>
IDocumentSession OpenSession(string database, ICredentials credentialsForSession);
/// <summary>
/// Opens the session with the specified credentials.
/// </summary>
/// <param name="credentialsForSession">The credentials for session.</param>
IDocumentSession OpenSession(ICredentials credentialsForSession);
/// <summary>
/// Gets the database commands.
/// </summary>
/// <value>The database commands.</value>
IDatabaseCommands DatabaseCommands { get; }
#endif
/// <summary>
/// Gets the conventions.
/// </summary>
/// <value>The conventions.</value>
DocumentConvention Conventions { get; }
/// <summary>
/// Gets the URL.
/// </summary>
string Url { get; }
///<summary>
/// Gets the etag of the last document written by any session belonging to this
/// document store
///</summary>
Guid? GetLastWrittenEtag();
}
}