|
0
|
1 <?xml version="1.0"?>
|
|
|
2 <doc>
|
|
|
3 <assembly>
|
|
|
4 <name>LiteDB</name>
|
|
|
5 </assembly>
|
|
|
6 <members>
|
|
|
7 <member name="M:LiteDB.LiteCollection`1.Include(System.Action{`0})">
|
|
|
8 <summary>
|
|
|
9 Run an include action in each document returned by Find(), FindById(), FindOne() and All() methods. Useful for load reference documents when nedded.
|
|
|
10 Returns a new Collection with this action included
|
|
|
11 </summary>
|
|
|
12 </member>
|
|
|
13 <member name="M:LiteDB.LiteCollection`1.Drop">
|
|
|
14 <summary>
|
|
|
15 Drop a collection deleting all documents and indexes
|
|
|
16 </summary>
|
|
|
17 </member>
|
|
|
18 <member name="M:LiteDB.LiteCollection`1.InsertBulk(System.Collections.Generic.IEnumerable{`0},System.Int32)">
|
|
|
19 <summary>
|
|
|
20 Bulk documents to a collection - use data chunks for most efficient insert
|
|
|
21 </summary>
|
|
|
22 </member>
|
|
|
23 <member name="M:LiteDB.LiteCollection`1.GetCollectionPage(System.Boolean)">
|
|
|
24 <summary>
|
|
|
25 Get the collection page only when nedded. Gets from cache always to garantee that wil be the last (in case of _clearCache will get a new one)
|
|
|
26 </summary>
|
|
|
27 </member>
|
|
|
28 <member name="M:LiteDB.LiteCollection`1.GetBsonCollection">
|
|
|
29 <summary>
|
|
|
30 Returns a new instance of this collection but using BsonDocument as T - Copy _pageID to avoid new collection page search
|
|
|
31 </summary>
|
|
|
32 </member>
|
|
|
33 <member name="M:LiteDB.LiteCollection`1.Delete(LiteDB.BsonValue)">
|
|
|
34 <summary>
|
|
|
35 Remove an document in collection using Document Id - returns false if not found document
|
|
|
36 </summary>
|
|
|
37 </member>
|
|
|
38 <member name="M:LiteDB.LiteCollection`1.Delete(LiteDB.Query)">
|
|
|
39 <summary>
|
|
|
40 Remove all document based on a Query object. Returns removed document counts
|
|
|
41 </summary>
|
|
|
42 </member>
|
|
|
43 <member name="M:LiteDB.LiteCollection`1.Delete(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
|
|
|
44 <summary>
|
|
|
45 Remove all document based on a LINQ query. Returns removed document counts
|
|
|
46 </summary>
|
|
|
47 </member>
|
|
|
48 <member name="M:LiteDB.LiteCollection`1.EnsureIndex(System.String,LiteDB.IndexOptions)">
|
|
|
49 <summary>
|
|
|
50 Create a new permanent index in all documents inside this collections if index not exists already. Returns true if index was created or false if already exits
|
|
|
51 </summary>
|
|
|
52 <param name="field">Document field name (case sensitive)</param>
|
|
|
53 <param name="options">All index options</param>
|
|
|
54 </member>
|
|
|
55 <member name="M:LiteDB.LiteCollection`1.EnsureIndex(System.String,System.Boolean)">
|
|
|
56 <summary>
|
|
|
57 Create a new permanent index in all documents inside this collections if index not exists already. Returns true if index was created or false if already exits
|
|
|
58 </summary>
|
|
|
59 <param name="field">Document field name (case sensitive)</param>
|
|
|
60 <param name="unique">All index options</param>
|
|
|
61 </member>
|
|
|
62 <member name="M:LiteDB.LiteCollection`1.EnsureIndex``1(System.Linq.Expressions.Expression{System.Func{`0,``0}},System.Boolean)">
|
|
|
63 <summary>
|
|
|
64 Create a new permanent index in all documents inside this collections if index not exists already.
|
|
|
65 </summary>
|
|
|
66 <param name="property">Property linq expression</param>
|
|
|
67 <param name="unique">Create a unique values index?</param>
|
|
|
68 </member>
|
|
|
69 <member name="M:LiteDB.LiteCollection`1.EnsureIndex``1(System.Linq.Expressions.Expression{System.Func{`0,``0}},LiteDB.IndexOptions)">
|
|
|
70 <summary>
|
|
|
71 Create a new permanent index in all documents inside this collections if index not exists already.
|
|
|
72 </summary>
|
|
|
73 <param name="property">Property linq expression</param>
|
|
|
74 <param name="options">Use all indexes options</param>
|
|
|
75 </member>
|
|
|
76 <member name="M:LiteDB.LiteCollection`1.GetIndexes">
|
|
|
77 <summary>
|
|
|
78 Returns all indexes in this collections
|
|
|
79 </summary>
|
|
|
80 </member>
|
|
|
81 <member name="M:LiteDB.LiteCollection`1.DropIndex(System.String)">
|
|
|
82 <summary>
|
|
|
83 Drop index and release slot for another index
|
|
|
84 </summary>
|
|
|
85 </member>
|
|
|
86 <member name="M:LiteDB.LiteCollection`1.Find(LiteDB.Query,System.Int32,System.Int32)">
|
|
|
87 <summary>
|
|
|
88 Find documents inside a collection using Query object. Must have indexes in query expression
|
|
|
89 </summary>
|
|
|
90 </member>
|
|
|
91 <member name="M:LiteDB.LiteCollection`1.Find(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Int32,System.Int32)">
|
|
|
92 <summary>
|
|
|
93 Find documents inside a collection using Linq expression. Must have indexes in linq expression
|
|
|
94 </summary>
|
|
|
95 </member>
|
|
|
96 <member name="M:LiteDB.LiteCollection`1.FindById(LiteDB.BsonValue)">
|
|
|
97 <summary>
|
|
|
98 Find a document using Document Id. Returns null if not found.
|
|
|
99 </summary>
|
|
|
100 </member>
|
|
|
101 <member name="M:LiteDB.LiteCollection`1.FindOne(LiteDB.Query)">
|
|
|
102 <summary>
|
|
|
103 Find the first document using Query object. Returns null if not found. Must have index on query expression.
|
|
|
104 </summary>
|
|
|
105 </member>
|
|
|
106 <member name="M:LiteDB.LiteCollection`1.FindOne(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
|
|
|
107 <summary>
|
|
|
108 Find the first document using Linq expression. Returns null if not found. Must have indexes on predicate.
|
|
|
109 </summary>
|
|
|
110 </member>
|
|
|
111 <member name="M:LiteDB.LiteCollection`1.FindAll">
|
|
|
112 <summary>
|
|
|
113 Returns all documents inside collection order by _id index.
|
|
|
114 </summary>
|
|
|
115 </member>
|
|
|
116 <member name="M:LiteDB.LiteCollection`1.Count">
|
|
|
117 <summary>
|
|
|
118 Get document count using property on collection.
|
|
|
119 </summary>
|
|
|
120 </member>
|
|
|
121 <member name="M:LiteDB.LiteCollection`1.Count(LiteDB.Query)">
|
|
|
122 <summary>
|
|
|
123 Count documnets with a query. This method does not deserialize any document. Needs indexes on query expression
|
|
|
124 </summary>
|
|
|
125 </member>
|
|
|
126 <member name="M:LiteDB.LiteCollection`1.Count(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
|
|
|
127 <summary>
|
|
|
128 Count documnets with a query. This method does not deserialize any document. Needs indexes on query expression
|
|
|
129 </summary>
|
|
|
130 </member>
|
|
|
131 <member name="M:LiteDB.LiteCollection`1.Exists(LiteDB.Query)">
|
|
|
132 <summary>
|
|
|
133 Returns true if query returns any document. This method does not deserialize any document. Needs indexes on query expression
|
|
|
134 </summary>
|
|
|
135 </member>
|
|
|
136 <member name="M:LiteDB.LiteCollection`1.Exists(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
|
|
|
137 <summary>
|
|
|
138 Returns true if query returns any document. This method does not deserialize any document. Needs indexes on query expression
|
|
|
139 </summary>
|
|
|
140 </member>
|
|
|
141 <member name="M:LiteDB.LiteCollection`1.Min(System.String)">
|
|
|
142 <summary>
|
|
|
143 Returns the first/min value from a index field
|
|
|
144 </summary>
|
|
|
145 </member>
|
|
|
146 <member name="M:LiteDB.LiteCollection`1.Min">
|
|
|
147 <summary>
|
|
|
148 Returns the first/min _id field
|
|
|
149 </summary>
|
|
|
150 </member>
|
|
|
151 <member name="M:LiteDB.LiteCollection`1.Min``1(System.Linq.Expressions.Expression{System.Func{`0,``0}})">
|
|
|
152 <summary>
|
|
|
153 Returns the first/min field using a linq expression
|
|
|
154 </summary>
|
|
|
155 </member>
|
|
|
156 <member name="M:LiteDB.LiteCollection`1.Max(System.String)">
|
|
|
157 <summary>
|
|
|
158 Returns the last/max value from a index field
|
|
|
159 </summary>
|
|
|
160 </member>
|
|
|
161 <member name="M:LiteDB.LiteCollection`1.Max">
|
|
|
162 <summary>
|
|
|
163 Returns the last/max _id field
|
|
|
164 </summary>
|
|
|
165 </member>
|
|
|
166 <member name="M:LiteDB.LiteCollection`1.Max``1(System.Linq.Expressions.Expression{System.Func{`0,``0}})">
|
|
|
167 <summary>
|
|
|
168 Returns the last/max field using a linq expression
|
|
|
169 </summary>
|
|
|
170 </member>
|
|
|
171 <member name="M:LiteDB.LiteCollection`1.Insert(`0)">
|
|
|
172 <summary>
|
|
|
173 Insert a new document to this collection. Document Id must be a new value in collection - Returns document Id
|
|
|
174 </summary>
|
|
|
175 </member>
|
|
|
176 <member name="M:LiteDB.LiteCollection`1.Insert(System.Collections.Generic.IEnumerable{`0})">
|
|
|
177 <summary>
|
|
|
178 Insert an array of new documents to this collection. Document Id must be a new value in collection
|
|
|
179 </summary>
|
|
|
180 </member>
|
|
|
181 <member name="M:LiteDB.LiteCollection`1.Update(`0)">
|
|
|
182 <summary>
|
|
|
183 Update a document in this collection. Returns false if not found document in collection
|
|
|
184 </summary>
|
|
|
185 </member>
|
|
|
186 <member name="M:LiteDB.LiteCollection`1.Update(LiteDB.BsonValue,`0)">
|
|
|
187 <summary>
|
|
|
188 Update a document in this collection. Returns false if not found document in collection
|
|
|
189 </summary>
|
|
|
190 </member>
|
|
|
191 <member name="P:LiteDB.LiteCollection`1.Name">
|
|
|
192 <summary>
|
|
|
193 Get collection name
|
|
|
194 </summary>
|
|
|
195 </member>
|
|
|
196 <member name="P:LiteDB.LiteCollection`1.Database">
|
|
|
197 <summary>
|
|
|
198 Gets database object reference
|
|
|
199 </summary>
|
|
|
200 </member>
|
|
|
201 <member name="T:LiteDB.DbRef`1">
|
|
|
202 <summary>
|
|
|
203 Creates a field that is a reference for another document from another collection. T is another type
|
|
|
204 </summary>
|
|
|
205 </member>
|
|
|
206 <member name="M:LiteDB.DbRef`1.#ctor">
|
|
|
207 <summary>
|
|
|
208 Used only for serialization/deserialize
|
|
|
209 </summary>
|
|
|
210 </member>
|
|
|
211 <member name="M:LiteDB.DbRef`1.#ctor(System.String,LiteDB.BsonValue)">
|
|
|
212 <summary>
|
|
|
213 Initialize using reference collection name and collection Id
|
|
|
214 </summary>
|
|
|
215 </member>
|
|
|
216 <member name="M:LiteDB.DbRef`1.#ctor(LiteDB.LiteCollection{`0},LiteDB.BsonValue)">
|
|
|
217 <summary>
|
|
|
218 Initialize using reference collection name and collection Id
|
|
|
219 </summary>
|
|
|
220 </member>
|
|
|
221 <member name="M:LiteDB.DbRef`1.Fetch(LiteDB.LiteDatabase)">
|
|
|
222 <summary>
|
|
|
223 Fetch document reference return them. After fetch, you can use "Item" proerty do get ref document
|
|
|
224 </summary>
|
|
|
225 </member>
|
|
|
226 <member name="T:LiteDB.LiteDatabase">
|
|
|
227 <summary>
|
|
|
228 The LiteDB database. Used for create a LiteDB instance and use all storage resoures. It's the database connection
|
|
|
229 </summary>
|
|
|
230 </member>
|
|
|
231 <member name="M:LiteDB.LiteDatabase.RunCommand(System.String)">
|
|
|
232 <summary>
|
|
|
233 Run a shell command in current database. Returns a BsonValue as result
|
|
|
234 </summary>
|
|
|
235 </member>
|
|
|
236 <member name="M:LiteDB.LiteDatabase.OnVersionUpdate(System.Int32)">
|
|
|
237 <summary>
|
|
|
238 Virtual method for update database when a new version (from coneection string) was setted
|
|
|
239 </summary>
|
|
|
240 <param name="newVersion">The new database version</param>
|
|
|
241 </member>
|
|
|
242 <member name="M:LiteDB.LiteDatabase.UpdateDatabaseVersion">
|
|
|
243 <summary>
|
|
|
244 Update database version, when necessary
|
|
|
245 </summary>
|
|
|
246 </member>
|
|
|
247 <member name="M:LiteDB.LiteDatabase.GetDatabaseInfo">
|
|
|
248 <summary>
|
|
|
249 Get all database information
|
|
|
250 </summary>
|
|
|
251 </member>
|
|
|
252 <member name="M:LiteDB.LiteDatabase.#ctor(System.String)">
|
|
|
253 <summary>
|
|
|
254 Starts LiteDB database. Open database file or create a new one if not exits
|
|
|
255 </summary>
|
|
|
256 <param name="connectionString">Full filename or connection string</param>
|
|
|
257 </member>
|
|
|
258 <member name="M:LiteDB.LiteDatabase.GetCollection``1(System.String)">
|
|
|
259 <summary>
|
|
|
260 Get a collection using a entity class as strong typed document. If collection does not exits, create a new one.
|
|
|
261 </summary>
|
|
|
262 <param name="name">Collection name (case insensitive)</param>
|
|
|
263 </member>
|
|
|
264 <member name="M:LiteDB.LiteDatabase.GetCollection(System.String)">
|
|
|
265 <summary>
|
|
|
266 Get a collection using a generic BsonDocument. If collection does not exits, create a new one.
|
|
|
267 </summary>
|
|
|
268 <param name="name">Collection name (case insensitive)</param>
|
|
|
269 </member>
|
|
|
270 <member name="M:LiteDB.LiteDatabase.GetCollectionNames">
|
|
|
271 <summary>
|
|
|
272 Get all collections name inside this database.
|
|
|
273 </summary>
|
|
|
274 </member>
|
|
|
275 <member name="M:LiteDB.LiteDatabase.CollectionExists(System.String)">
|
|
|
276 <summary>
|
|
|
277 Checks if a collection exists on database. Collection name is case unsensitive
|
|
|
278 </summary>
|
|
|
279 </member>
|
|
|
280 <member name="M:LiteDB.LiteDatabase.DropCollection(System.String)">
|
|
|
281 <summary>
|
|
|
282 Drop a collection and all data + indexes
|
|
|
283 </summary>
|
|
|
284 </member>
|
|
|
285 <member name="M:LiteDB.LiteDatabase.RenameCollection(System.String,System.String)">
|
|
|
286 <summary>
|
|
|
287 Rename a collection. Returns false if oldName does not exists or newName already exists
|
|
|
288 </summary>
|
|
|
289 </member>
|
|
|
290 <member name="M:LiteDB.LiteDatabase.BeginTrans">
|
|
|
291 <summary>
|
|
|
292 Starts a new transaction. After this command, all write operations will be first in memory and will persist on disk
|
|
|
293 only when call Commit() method. If any error occurs, a Rollback() method will run.
|
|
|
294 </summary>
|
|
|
295 </member>
|
|
|
296 <member name="M:LiteDB.LiteDatabase.Commit">
|
|
|
297 <summary>
|
|
|
298 Persist all changes on disk. Always use this method to finish your changes on database
|
|
|
299 </summary>
|
|
|
300 </member>
|
|
|
301 <member name="M:LiteDB.LiteDatabase.Rollback">
|
|
|
302 <summary>
|
|
|
303 Cancel all write operations and keep datafile as is before BeginTrans() called.
|
|
|
304 Rollback are implicit on a database operation error, so you do not need call for database errors (only on business rules).
|
|
|
305 </summary>
|
|
|
306 </member>
|
|
|
307 <member name="P:LiteDB.LiteDatabase.FileStorage">
|
|
|
308 <summary>
|
|
|
309 Returns a special collection for storage files/stream inside datafile
|
|
|
310 </summary>
|
|
|
311 </member>
|
|
|
312 <member name="T:LiteDB.ObjectId">
|
|
|
313 <summary>
|
|
|
314 Represent a 12-bytes BSON type used in document Id
|
|
|
315 </summary>
|
|
|
316 </member>
|
|
|
317 <member name="F:LiteDB.ObjectId.Empty">
|
|
|
318 <summary>
|
|
|
319 A zero 12-bytes ObjectId
|
|
|
320 </summary>
|
|
|
321 </member>
|
|
|
322 <member name="M:LiteDB.ObjectId.#ctor">
|
|
|
323 <summary>
|
|
|
324 Initializes a new empty instance of the ObjectId class.
|
|
|
325 </summary>
|
|
|
326 </member>
|
|
|
327 <member name="M:LiteDB.ObjectId.#ctor(System.Int32,System.Int32,System.Int16,System.Int32)">
|
|
|
328 <summary>
|
|
|
329 Initializes a new instance of the ObjectId class from ObjectId vars.
|
|
|
330 </summary>
|
|
|
331 </member>
|
|
|
332 <member name="M:LiteDB.ObjectId.#ctor(LiteDB.ObjectId)">
|
|
|
333 <summary>
|
|
|
334 Initializes a new instance of ObjectId class from another ObjectId.
|
|
|
335 </summary>
|
|
|
336 </member>
|
|
|
337 <member name="M:LiteDB.ObjectId.#ctor(System.String)">
|
|
|
338 <summary>
|
|
|
339 Initializes a new instance of the ObjectId class from hex string.
|
|
|
340 </summary>
|
|
|
341 </member>
|
|
|
342 <member name="M:LiteDB.ObjectId.#ctor(System.Byte[])">
|
|
|
343 <summary>
|
|
|
344 Initializes a new instance of the ObjectId class from byte array.
|
|
|
345 </summary>
|
|
|
346 </member>
|
|
|
347 <member name="M:LiteDB.ObjectId.FromHex(System.String)">
|
|
|
348 <summary>
|
|
|
349 Convert hex value string in byte array
|
|
|
350 </summary>
|
|
|
351 </member>
|
|
|
352 <member name="M:LiteDB.ObjectId.Equals(LiteDB.ObjectId)">
|
|
|
353 <summary>
|
|
|
354 Equalses the specified other.
|
|
|
355 </summary>
|
|
|
356 </member>
|
|
|
357 <member name="M:LiteDB.ObjectId.Equals(System.Object)">
|
|
|
358 <summary>
|
|
|
359 Determines whether the specified object is equal to this instance.
|
|
|
360 </summary>
|
|
|
361 </member>
|
|
|
362 <member name="M:LiteDB.ObjectId.GetHashCode">
|
|
|
363 <summary>
|
|
|
364 Returns a hash code for this instance.
|
|
|
365 </summary>
|
|
|
366 </member>
|
|
|
367 <member name="M:LiteDB.ObjectId.CompareTo(LiteDB.ObjectId)">
|
|
|
368 <summary>
|
|
|
369 Compares two instances of ObjectId
|
|
|
370 </summary>
|
|
|
371 </member>
|
|
|
372 <member name="M:LiteDB.ObjectId.ToByteArray">
|
|
|
373 <summary>
|
|
|
374 Represent ObjectId as 12 bytes array
|
|
|
375 </summary>
|
|
|
376 </member>
|
|
|
377 <member name="M:LiteDB.ObjectId.NewObjectId">
|
|
|
378 <summary>
|
|
|
379 Creates a new ObjectId.
|
|
|
380 </summary>
|
|
|
381 </member>
|
|
|
382 <member name="P:LiteDB.ObjectId.Timestamp">
|
|
|
383 <summary>
|
|
|
384 Get timestamp
|
|
|
385 </summary>
|
|
|
386 </member>
|
|
|
387 <member name="P:LiteDB.ObjectId.Machine">
|
|
|
388 <summary>
|
|
|
389 Get machine number
|
|
|
390 </summary>
|
|
|
391 </member>
|
|
|
392 <member name="P:LiteDB.ObjectId.Pid">
|
|
|
393 <summary>
|
|
|
394 Get pid number
|
|
|
395 </summary>
|
|
|
396 </member>
|
|
|
397 <member name="P:LiteDB.ObjectId.Increment">
|
|
|
398 <summary>
|
|
|
399 Get increment
|
|
|
400 </summary>
|
|
|
401 </member>
|
|
|
402 <member name="P:LiteDB.ObjectId.CreationTime">
|
|
|
403 <summary>
|
|
|
404 Get creation time
|
|
|
405 </summary>
|
|
|
406 </member>
|
|
|
407 <member name="T:LiteDB.QueryContains">
|
|
|
408 <summary>
|
|
|
409 Contains query do not work with index, only full scan
|
|
|
410 </summary>
|
|
|
411 </member>
|
|
|
412 <member name="T:LiteDB.Query">
|
|
|
413 <summary>
|
|
|
414 Class helper to create query using indexes in database. All methods are statics.
|
|
|
415 Queries can be executed in 2 ways: Index Seek (fast), Index Scan (good)
|
|
|
416 </summary>
|
|
|
417 </member>
|
|
|
418 <member name="F:LiteDB.Query.Ascending">
|
|
|
419 <summary>
|
|
|
420 Indicate when a query must execute in ascending order
|
|
|
421 </summary>
|
|
|
422 </member>
|
|
|
423 <member name="F:LiteDB.Query.Descending">
|
|
|
424 <summary>
|
|
|
425 Indicate when a query must execute in descending order
|
|
|
426 </summary>
|
|
|
427 </member>
|
|
|
428 <member name="M:LiteDB.Query.All(System.Int32)">
|
|
|
429 <summary>
|
|
|
430 Returns all documents using _id index order
|
|
|
431 </summary>
|
|
|
432 </member>
|
|
|
433 <member name="M:LiteDB.Query.All(System.String,System.Int32)">
|
|
|
434 <summary>
|
|
|
435 Returns all documents using field index order
|
|
|
436 </summary>
|
|
|
437 </member>
|
|
|
438 <member name="M:LiteDB.Query.EQ(System.String,LiteDB.BsonValue)">
|
|
|
439 <summary>
|
|
|
440 Returns all documents that value are equals to value (=)
|
|
|
441 </summary>
|
|
|
442 </member>
|
|
|
443 <member name="M:LiteDB.Query.LT(System.String,LiteDB.BsonValue)">
|
|
|
444 <summary>
|
|
|
445 Returns all documents that value are less than value (<)
|
|
|
446 </summary>
|
|
|
447 </member>
|
|
|
448 <member name="M:LiteDB.Query.LTE(System.String,LiteDB.BsonValue)">
|
|
|
449 <summary>
|
|
|
450 Returns all documents that value are less than or equals value (<=)
|
|
|
451 </summary>
|
|
|
452 </member>
|
|
|
453 <member name="M:LiteDB.Query.GT(System.String,LiteDB.BsonValue)">
|
|
|
454 <summary>
|
|
|
455 Returns all document that value are greater than value (>)
|
|
|
456 </summary>
|
|
|
457 </member>
|
|
|
458 <member name="M:LiteDB.Query.GTE(System.String,LiteDB.BsonValue)">
|
|
|
459 <summary>
|
|
|
460 Returns all documents that value are greater than or equals value (>=)
|
|
|
461 </summary>
|
|
|
462 </member>
|
|
|
463 <member name="M:LiteDB.Query.Between(System.String,LiteDB.BsonValue,LiteDB.BsonValue)">
|
|
|
464 <summary>
|
|
|
465 Returns all document that values are between "start" and "end" values (BETWEEN)
|
|
|
466 </summary>
|
|
|
467 </member>
|
|
|
468 <member name="M:LiteDB.Query.StartsWith(System.String,System.String)">
|
|
|
469 <summary>
|
|
|
470 Returns all documents that starts with value (LIKE)
|
|
|
471 </summary>
|
|
|
472 </member>
|
|
|
473 <member name="M:LiteDB.Query.Contains(System.String,System.String)">
|
|
|
474 <summary>
|
|
|
475 Returns all documents that contains value (CONTAINS)
|
|
|
476 </summary>
|
|
|
477 </member>
|
|
|
478 <member name="M:LiteDB.Query.Not(System.String,LiteDB.BsonValue)">
|
|
|
479 <summary>
|
|
|
480 Returns all documents that are not equals to value
|
|
|
481 </summary>
|
|
|
482 </member>
|
|
|
483 <member name="M:LiteDB.Query.In(System.String,LiteDB.BsonArray)">
|
|
|
484 <summary>
|
|
|
485 Returns all documents that has value in values list (IN)
|
|
|
486 </summary>
|
|
|
487 </member>
|
|
|
488 <member name="M:LiteDB.Query.In(System.String,LiteDB.BsonValue[])">
|
|
|
489 <summary>
|
|
|
490 Returns all documents that has value in values list (IN)
|
|
|
491 </summary>
|
|
|
492 </member>
|
|
|
493 <member name="M:LiteDB.Query.And(LiteDB.Query,LiteDB.Query)">
|
|
|
494 <summary>
|
|
|
495 Returns document that exists in BOTH queries results (Intersect).
|
|
|
496 </summary>
|
|
|
497 </member>
|
|
|
498 <member name="M:LiteDB.Query.Or(LiteDB.Query,LiteDB.Query)">
|
|
|
499 <summary>
|
|
|
500 Returns documents that exists in ANY queries results (Union).
|
|
|
501 </summary>
|
|
|
502 </member>
|
|
|
503 <member name="M:LiteDB.Query.ExecuteIndex(LiteDB.IndexService,LiteDB.CollectionIndex)">
|
|
|
504 <summary>
|
|
|
505 Abstract method that must be implement for index seek/scan - Returns IndexNodes that match with index
|
|
|
506 </summary>
|
|
|
507 </member>
|
|
|
508 <member name="M:LiteDB.Query.Run``1(LiteDB.LiteCollection{``0})">
|
|
|
509 <summary>
|
|
|
510 Find witch index will be used and run Execute method - define ExecuteMode here
|
|
|
511 </summary>
|
|
|
512 </member>
|
|
|
513 <member name="T:LiteDB.QueryVisitor`1">
|
|
|
514 <summary>
|
|
|
515 Class helper to create Queries based on Linq expressions
|
|
|
516 </summary>
|
|
|
517 </member>
|
|
|
518 <member name="M:LiteDB.QueryVisitor`1.GetBsonField``2(System.Linq.Expressions.Expression{System.Func{``0,``1}})">
|
|
|
519 <summary>
|
|
|
520 Get a Bson field from a simple Linq expression: x => x.CustomerName
|
|
|
521 </summary>
|
|
|
522 </member>
|
|
|
523 <member name="M:LiteDB.QueryVisitor`1.GetBsonField(System.String)">
|
|
|
524 <summary>
|
|
|
525 Get a bson string field based on class PropertyInfo using BsonMapper class
|
|
|
526 Support Name1.Name2 dotted notation
|
|
|
527 </summary>
|
|
|
528 </member>
|
|
|
529 <member name="M:LiteDB.QueryVisitor`1.GetTypeField(System.Type,System.String,System.Type@)">
|
|
|
530 <summary>
|
|
|
531 Get a field name passing mapper type and returns property type
|
|
|
532 </summary>
|
|
|
533 </member>
|
|
|
534 <member name="T:LiteDB.QueryNot">
|
|
|
535 <summary>
|
|
|
536 Not is an Index Scan operation
|
|
|
537 </summary>
|
|
|
538 </member>
|
|
|
539 <member name="T:LiteDB.QueryAll">
|
|
|
540 <summary>
|
|
|
541 All is an Index Scan operation
|
|
|
542 </summary>
|
|
|
543 </member>
|
|
|
544 <member name="T:LiteDB.JsonReader">
|
|
|
545 <summary>
|
|
|
546 A class that read a json string using a tokenizer (without regex)
|
|
|
547 </summary>
|
|
|
548 </member>
|
|
|
549 <member name="T:LiteDB.JsonTokenizer">
|
|
|
550 <summary>
|
|
|
551 Class that parse a json string and returns in json token
|
|
|
552 </summary>
|
|
|
553 </member>
|
|
|
554 <member name="M:LiteDB.JsonTokenizer.Read">
|
|
|
555 <summary>
|
|
|
556 Read next char in stream and set in _current
|
|
|
557 </summary>
|
|
|
558 </member>
|
|
|
559 <member name="M:LiteDB.JsonTokenizer.ReadToken">
|
|
|
560 <summary>
|
|
|
561 Read next json token
|
|
|
562 </summary>
|
|
|
563 </member>
|
|
|
564 <member name="M:LiteDB.JsonTokenizer.EatWhitespace">
|
|
|
565 <summary>
|
|
|
566 Eat all whitespaces - used before a valid token
|
|
|
567 </summary>
|
|
|
568 </member>
|
|
|
569 <member name="M:LiteDB.JsonTokenizer.ReadWord">
|
|
|
570 <summary>
|
|
|
571 Read a word without "
|
|
|
572 </summary>
|
|
|
573 </member>
|
|
|
574 <member name="M:LiteDB.JsonTokenizer.ReadNumber">
|
|
|
575 <summary>
|
|
|
576 Read a number - it's accepts all number char, but not validate. When run Convert, .NET will check if number is correct
|
|
|
577 </summary>
|
|
|
578 </member>
|
|
|
579 <member name="M:LiteDB.JsonTokenizer.ReadString">
|
|
|
580 <summary>
|
|
|
581 Read a string removing open and close "
|
|
|
582 </summary>
|
|
|
583 </member>
|
|
|
584 <member name="T:LiteDB.BsonIgnoreAttribute">
|
|
|
585 <summary>
|
|
|
586 Indicate that property will not be persist in Bson serialization
|
|
|
587 </summary>
|
|
|
588 </member>
|
|
|
589 <member name="T:LiteDB.BsonIdAttribute">
|
|
|
590 <summary>
|
|
|
591 Indicate that property will be used as BsonDocument Id
|
|
|
592 </summary>
|
|
|
593 </member>
|
|
|
594 <member name="P:LiteDB.LiteFileStream.FileInfo">
|
|
|
595 <summary>
|
|
|
596 Get file information
|
|
|
597 </summary>
|
|
|
598 </member>
|
|
|
599 <member name="T:LiteDB.LiteFileInfo">
|
|
|
600 <summary>
|
|
|
601 Represets a file inside storage collection
|
|
|
602 </summary>
|
|
|
603 </member>
|
|
|
604 <member name="F:LiteDB.LiteFileInfo.ID_PATTERN">
|
|
|
605 <summary>
|
|
|
606 File id have a specific format - it's like file path.
|
|
|
607 </summary>
|
|
|
608 </member>
|
|
|
609 <member name="F:LiteDB.LiteFileInfo.CHUNK_SIZE">
|
|
|
610 <summary>
|
|
|
611 Number of bytes on each chunk document to store
|
|
|
612 </summary>
|
|
|
613 </member>
|
|
|
614 <member name="M:LiteDB.LiteFileInfo.GetChunckId(System.String,System.Int32)">
|
|
|
615 <summary>
|
|
|
616 Returns chunck Id for a file
|
|
|
617 </summary>
|
|
|
618 </member>
|
|
|
619 <member name="M:LiteDB.LiteFileInfo.OpenRead">
|
|
|
620 <summary>
|
|
|
621 Open file stream to read from database
|
|
|
622 </summary>
|
|
|
623 </member>
|
|
|
624 <member name="M:LiteDB.LiteFileInfo.SaveAs(System.String,System.Boolean)">
|
|
|
625 <summary>
|
|
|
626 Save file content to a external file
|
|
|
627 </summary>
|
|
|
628 </member>
|
|
|
629 <member name="M:LiteDB.LiteFileInfo.CopyTo(System.IO.Stream)">
|
|
|
630 <summary>
|
|
|
631 Copy file content to another stream
|
|
|
632 </summary>
|
|
|
633 </member>
|
|
|
634 <member name="T:LiteDB.LiteFileStorage">
|
|
|
635 <summary>
|
|
|
636 Storage is a special collection to store files/streams.
|
|
|
637 </summary>
|
|
|
638 </member>
|
|
|
639 <member name="M:LiteDB.LiteFileStorage.Upload(LiteDB.LiteFileInfo,System.IO.Stream)">
|
|
|
640 <summary>
|
|
|
641 Insert a new file content inside datafile in _files collection
|
|
|
642 </summary>
|
|
|
643 </member>
|
|
|
644 <member name="M:LiteDB.LiteFileStorage.Upload(System.String)">
|
|
|
645 <summary>
|
|
|
646 Upload a file to FileStorage using Path.GetFilename as file Id
|
|
|
647 </summary>
|
|
|
648 </member>
|
|
|
649 <member name="M:LiteDB.LiteFileStorage.SetMetadata(System.String,LiteDB.BsonDocument)">
|
|
|
650 <summary>
|
|
|
651 Update metada on a file. File must exisits
|
|
|
652 </summary>
|
|
|
653 </member>
|
|
|
654 <member name="M:LiteDB.LiteFileStorage.Download(System.String,System.IO.Stream)">
|
|
|
655 <summary>
|
|
|
656 Copy all file content to a steam
|
|
|
657 </summary>
|
|
|
658 </member>
|
|
|
659 <member name="M:LiteDB.LiteFileStorage.OpenRead(System.String)">
|
|
|
660 <summary>
|
|
|
661 Load data inside storage and returns as Stream
|
|
|
662 </summary>
|
|
|
663 </member>
|
|
|
664 <member name="M:LiteDB.LiteFileStorage.OpenRead(LiteDB.LiteFileInfo)">
|
|
|
665 <summary>
|
|
|
666 Load data inside storage and returns as Stream
|
|
|
667 </summary>
|
|
|
668 </member>
|
|
|
669 <member name="M:LiteDB.LiteFileStorage.FindById(System.String)">
|
|
|
670 <summary>
|
|
|
671 Find a file inside datafile and returns FileEntry instance. Returns null if not found
|
|
|
672 </summary>
|
|
|
673 </member>
|
|
|
674 <member name="M:LiteDB.LiteFileStorage.Find(System.String)">
|
|
|
675 <summary>
|
|
|
676 Returns all FileEntry founded starting with id passed.
|
|
|
677 </summary>
|
|
|
678 </member>
|
|
|
679 <member name="M:LiteDB.LiteFileStorage.Exists(System.String)">
|
|
|
680 <summary>
|
|
|
681 Returns if a file exisits in database
|
|
|
682 </summary>
|
|
|
683 </member>
|
|
|
684 <member name="M:LiteDB.LiteFileStorage.FindAll">
|
|
|
685 <summary>
|
|
|
686 Returns all FileEntry inside database
|
|
|
687 </summary>
|
|
|
688 </member>
|
|
|
689 <member name="M:LiteDB.LiteFileStorage.Delete(System.String)">
|
|
|
690 <summary>
|
|
|
691 Delete a file inside datafile and all metadata related
|
|
|
692 </summary>
|
|
|
693 </member>
|
|
|
694 <member name="T:LiteDB.BsonValue">
|
|
|
695 <summary>
|
|
|
696 Represent a Bson Value used in BsonDocument
|
|
|
697 </summary>
|
|
|
698 </member>
|
|
|
699 <member name="F:LiteDB.BsonValue.Null">
|
|
|
700 <summary>
|
|
|
701 Represent a Null bson type
|
|
|
702 </summary>
|
|
|
703 </member>
|
|
|
704 <member name="F:LiteDB.BsonValue.MinValue">
|
|
|
705 <summary>
|
|
|
706 Represent a MinValue bson type
|
|
|
707 </summary>
|
|
|
708 </member>
|
|
|
709 <member name="F:LiteDB.BsonValue.MaxValue">
|
|
|
710 <summary>
|
|
|
711 Represent a MaxValue bson type
|
|
|
712 </summary>
|
|
|
713 </member>
|
|
|
714 <member name="M:LiteDB.BsonValue.GetBytesCount">
|
|
|
715 <summary>
|
|
|
716 Returns how many bytes this BsonValue will use to persist in index writes
|
|
|
717 </summary>
|
|
|
718 </member>
|
|
|
719 <member name="M:LiteDB.BsonValue.Normalize(LiteDB.IndexOptions)">
|
|
|
720 <summary>
|
|
|
721 Normalize a string value using IndexOptions and returns a new BsonValue - if is not a string, returns some BsonValue instance
|
|
|
722 </summary>
|
|
|
723 </member>
|
|
|
724 <member name="P:LiteDB.BsonValue.Type">
|
|
|
725 <summary>
|
|
|
726 Indicate BsonType of this BsonValue
|
|
|
727 </summary>
|
|
|
728 </member>
|
|
|
729 <member name="P:LiteDB.BsonValue.RawValue">
|
|
|
730 <summary>
|
|
|
731 Get internal .NET value object
|
|
|
732 </summary>
|
|
|
733 </member>
|
|
|
734 <member name="T:LiteDB.BsonType">
|
|
|
735 <summary>
|
|
|
736 All supported BsonTypes in sort order
|
|
|
737 </summary>
|
|
|
738 </member>
|
|
|
739 <member name="M:LiteDB.BsonDocument.Add(System.String,LiteDB.BsonValue)">
|
|
|
740 <summary>
|
|
|
741 Add fields in fluent api
|
|
|
742 </summary>
|
|
|
743 </member>
|
|
|
744 <member name="M:LiteDB.BsonDocument.ContainsKey(System.String)">
|
|
|
745 <summary>
|
|
|
746 Returns if object contains a named property
|
|
|
747 </summary>
|
|
|
748 </member>
|
|
|
749 <member name="M:LiteDB.BsonDocument.RemoveKey(System.String)">
|
|
|
750 <summary>
|
|
|
751 Remove a specific key on object
|
|
|
752 </summary>
|
|
|
753 </member>
|
|
|
754 <member name="M:LiteDB.BsonDocument.IsValidFieldName(System.String)">
|
|
|
755 <summary>
|
|
|
756 Test if field name is a valid string: only \w+(\w-)*
|
|
|
757 </summary>
|
|
|
758 </member>
|
|
|
759 <member name="M:LiteDB.BsonDocument.Get(System.String)">
|
|
|
760 <summary>
|
|
|
761 Get value from a path - supports dotted path like: Customer.Address.Street
|
|
|
762 </summary>
|
|
|
763 </member>
|
|
|
764 <member name="M:LiteDB.BsonDocument.Set(System.String,LiteDB.BsonValue)">
|
|
|
765 <summary>
|
|
|
766 Set value to a path - supports dotted path like: Customer.Address.Street - Fluent API (returns same BsonDocument)
|
|
|
767 </summary>
|
|
|
768 </member>
|
|
|
769 <member name="P:LiteDB.BsonDocument.Item(System.String)">
|
|
|
770 <summary>
|
|
|
771 Get/Set a field for document. Fields are case sensitive
|
|
|
772 </summary>
|
|
|
773 </member>
|
|
|
774 <member name="P:LiteDB.BsonDocument.Keys">
|
|
|
775 <summary>
|
|
|
776 Returns all object keys with _id in first order
|
|
|
777 </summary>
|
|
|
778 </member>
|
|
|
779 <member name="P:LiteDB.BsonDocument.Count">
|
|
|
780 <summary>
|
|
|
781 Returns how many fields this object contains
|
|
|
782 </summary>
|
|
|
783 </member>
|
|
|
784 <member name="T:LiteDB.BsonSerializer">
|
|
|
785 <summary>
|
|
|
786 Class to call method for convert BsonDocument to/from byte[] - based on http://bsonspec.org/spec.html
|
|
|
787 </summary>
|
|
|
788 </member>
|
|
|
789 <member name="M:LiteDB.BsonWriter.WriteDocument(System.IO.BinaryWriter,LiteDB.BsonDocument)">
|
|
|
790 <summary>
|
|
|
791 Write a bson document
|
|
|
792 </summary>
|
|
|
793 </member>
|
|
|
794 <member name="T:LiteDB.JsonSerializer">
|
|
|
795 <summary>
|
|
|
796 Static class for serialize/deserialize BsonDocuments into json extended format
|
|
|
797 </summary>
|
|
|
798 </member>
|
|
|
799 <member name="M:LiteDB.JsonSerializer.Serialize(LiteDB.BsonValue,System.Boolean,System.Boolean)">
|
|
|
800 <summary>
|
|
|
801 Json serialize a BsonValue into a String
|
|
|
802 </summary>
|
|
|
803 </member>
|
|
|
804 <member name="M:LiteDB.JsonSerializer.Serialize(LiteDB.BsonValue,System.IO.TextWriter,System.Boolean,System.Boolean)">
|
|
|
805 <summary>
|
|
|
806 Json serialize a BsonValue into a TextWriter
|
|
|
807 </summary>
|
|
|
808 </member>
|
|
|
809 <member name="M:LiteDB.JsonSerializer.Deserialize(System.String)">
|
|
|
810 <summary>
|
|
|
811 Deserialize a Json string into a BsonValue
|
|
|
812 </summary>
|
|
|
813 </member>
|
|
|
814 <member name="M:LiteDB.JsonSerializer.Deserialize(System.IO.TextReader)">
|
|
|
815 <summary>
|
|
|
816 Deserialize a Json TextReader into a BsonValue
|
|
|
817 </summary>
|
|
|
818 </member>
|
|
|
819 <member name="M:LiteDB.JsonSerializer.DeserializeArray(System.String)">
|
|
|
820 <summary>
|
|
|
821 Deserialize a json array as an IEnumerable of BsonValue
|
|
|
822 </summary>
|
|
|
823 </member>
|
|
|
824 <member name="M:LiteDB.JsonSerializer.DeserializeArray(System.IO.TextReader)">
|
|
|
825 <summary>
|
|
|
826 Deserialize a json array as an IEnumerable of BsonValue reading on demand TextReader
|
|
|
827 </summary>
|
|
|
828 </member>
|
|
|
829 <member name="M:LiteDB.JsonSerializer.Deserialize(LiteDB.StringScanner)">
|
|
|
830 <summary>
|
|
|
831 Deserialize a json using a StringScanner and returns BsonValue
|
|
|
832 </summary>
|
|
|
833 </member>
|
|
|
834 <member name="T:LiteDB.BsonMapper">
|
|
|
835 <summary>
|
|
|
836 Class that converts your entity class to/from BsonDocument
|
|
|
837 If you prefer use a new instance of BsonMapper (not Global), be sure cache this instance for better performance
|
|
|
838 Serialization rules:
|
|
|
839 - Classes must be "public" with a public constructor (without parameters)
|
|
|
840 - Properties must have public getter (can be read-only)
|
|
|
841 - Entity class must have Id property, [ClassName]Id property or [BsonId] attribute
|
|
|
842 - No circular references
|
|
|
843 - Fields are not valid
|
|
|
844 - IList, Array supports
|
|
|
845 - IDictionary supports (Key must be a simple datatype - converted by ChangeType)
|
|
|
846 </summary>
|
|
|
847 </member>
|
|
|
848 <member name="F:LiteDB.BsonMapper._mapper">
|
|
|
849 <summary>
|
|
|
850 Mapping cache between Class/BsonDocument
|
|
|
851 </summary>
|
|
|
852 </member>
|
|
|
853 <member name="F:LiteDB.BsonMapper._customSerializer">
|
|
|
854 <summary>
|
|
|
855 Map serializer/deserialize for custom types
|
|
|
856 </summary>
|
|
|
857 </member>
|
|
|
858 <member name="F:LiteDB.BsonMapper._autoId">
|
|
|
859 <summary>
|
|
|
860 Map for autoId type based functions
|
|
|
861 </summary>
|
|
|
862 </member>
|
|
|
863 <member name="F:LiteDB.BsonMapper.ResolvePropertyName">
|
|
|
864 <summary>
|
|
|
865 A resolver name property
|
|
|
866 </summary>
|
|
|
867 </member>
|
|
|
868 <member name="F:LiteDB.BsonMapper.Global">
|
|
|
869 <summary>
|
|
|
870 Global BsonMapper instance
|
|
|
871 </summary>
|
|
|
872 </member>
|
|
|
873 <member name="M:LiteDB.BsonMapper.RegisterType``1(System.Func{``0,LiteDB.BsonValue},System.Func{LiteDB.BsonValue,``0})">
|
|
|
874 <summary>
|
|
|
875 Register a custom type serializer/deserialize function
|
|
|
876 </summary>
|
|
|
877 </member>
|
|
|
878 <member name="M:LiteDB.BsonMapper.RegisterAutoId``1(System.Func{``0,System.Boolean},System.Func{LiteDB.LiteCollection{LiteDB.BsonDocument},``0})">
|
|
|
879 <summary>
|
|
|
880 Register a custom Auto Id generator function for a type
|
|
|
881 </summary>
|
|
|
882 </member>
|
|
|
883 <member name="M:LiteDB.BsonMapper.SetAutoId(System.Object,LiteDB.LiteCollection{LiteDB.BsonDocument})">
|
|
|
884 <summary>
|
|
|
885 Set new Id in entity class if entity needs one
|
|
|
886 </summary>
|
|
|
887 </member>
|
|
|
888 <member name="M:LiteDB.BsonMapper.GetPropertyMapper(System.Type)">
|
|
|
889 <summary>
|
|
|
890 Get property mapper between typed .NET class and BsonDocument - Cache results
|
|
|
891 </summary>
|
|
|
892 </member>
|
|
|
893 <member name="M:LiteDB.BsonMapper.GetIndexFromAttribute``1(System.String)">
|
|
|
894 <summary>
|
|
|
895 Search for [BsonIndex] in PropertyMapper. If not found, returns null
|
|
|
896 </summary>
|
|
|
897 </member>
|
|
|
898 <member name="M:LiteDB.BsonMapper.ToDocument(System.Object)">
|
|
|
899 <summary>
|
|
|
900 Serialize a entity class to BsonDocument
|
|
|
901 </summary>
|
|
|
902 </member>
|
|
|
903 <member name="M:LiteDB.BsonMapper.Serialize(System.Object)">
|
|
|
904 <summary>
|
|
|
905 Create a instance of a object convered in BsonValue object.
|
|
|
906 </summary>
|
|
|
907 </member>
|
|
|
908 <member name="M:LiteDB.BsonMapper.ToObject``1(LiteDB.BsonDocument)">
|
|
|
909 <summary>
|
|
|
910 Deserialize a BsonDocument to entity class
|
|
|
911 </summary>
|
|
|
912 </member>
|
|
|
913 <member name="M:LiteDB.BsonMapper.Deserialize``1(LiteDB.BsonValue)">
|
|
|
914 <summary>
|
|
|
915 Deserialize an BsonValue to .NET object typed in T
|
|
|
916 </summary>
|
|
|
917 </member>
|
|
|
918 <member name="P:LiteDB.BsonMapper.SerializeNullValues">
|
|
|
919 <summary>
|
|
|
920 Indicate that mapper do not serialize null values
|
|
|
921 </summary>
|
|
|
922 </member>
|
|
|
923 <member name="P:LiteDB.BsonMapper.TrimWhitespace">
|
|
|
924 <summary>
|
|
|
925 Apply .Trim() in strings
|
|
|
926 </summary>
|
|
|
927 </member>
|
|
|
928 <member name="P:LiteDB.BsonMapper.EmptyStringToNull">
|
|
|
929 <summary>
|
|
|
930 Convert EmptyString to Null
|
|
|
931 </summary>
|
|
|
932 </member>
|
|
|
933 <member name="T:LiteDB.BsonFieldAttribute">
|
|
|
934 <summary>
|
|
|
935 Set a name to this property in BsonDocument
|
|
|
936 </summary>
|
|
|
937 </member>
|
|
|
938 <member name="T:LiteDB.BsonIndexAttribute">
|
|
|
939 <summary>
|
|
|
940 Add an index in this entity property.
|
|
|
941 </summary>
|
|
|
942 </member>
|
|
|
943 <member name="P:LiteDB.AutoId.IsEmpty">
|
|
|
944 <summary>
|
|
|
945 Function to test if type is empty
|
|
|
946 </summary>
|
|
|
947 </member>
|
|
|
948 <member name="P:LiteDB.AutoId.NewId">
|
|
|
949 <summary>
|
|
|
950 Function that implements how generate a new Id for this type
|
|
|
951 </summary>
|
|
|
952 </member>
|
|
|
953 <member name="T:LiteDB.PropertyMapper">
|
|
|
954 <summary>
|
|
|
955 Internal representation for a .NET Property mapped to BsonDocument
|
|
|
956 </summary>
|
|
|
957 </member>
|
|
|
958 <member name="T:LiteDB.Reflection">
|
|
|
959 <summary>
|
|
|
960 Helper class to get entity properties and map as BsonValue
|
|
|
961 </summary>
|
|
|
962 </member>
|
|
|
963 <member name="M:LiteDB.Reflection.GetIdProperty(System.Type)">
|
|
|
964 <summary>
|
|
|
965 Gets PropertyInfo that refers to Id from a document object.
|
|
|
966 </summary>
|
|
|
967 </member>
|
|
|
968 <member name="M:LiteDB.Reflection.GetProperties(System.Type,System.Func{System.String,System.String})">
|
|
|
969 <summary>
|
|
|
970 Read all properties from a type - store in a static cache - exclude: Id and [BsonIgnore]
|
|
|
971 </summary>
|
|
|
972 </member>
|
|
|
973 <member name="M:LiteDB.Reflection.CreateInstance(System.Type)">
|
|
|
974 <summary>
|
|
|
975 Create a new instance from a Type
|
|
|
976 </summary>
|
|
|
977 </member>
|
|
|
978 <member name="M:LiteDB.Shell.Commands.BaseCollection.ReadCollection(LiteDB.LiteDatabase,LiteDB.StringScanner)">
|
|
|
979 <summary>
|
|
|
980 Read collection name from db.(colname).(command)
|
|
|
981 </summary>
|
|
|
982 </member>
|
|
|
983 <member name="M:LiteDB.Shell.Commands.BaseFileStorage.ReadId(LiteDB.StringScanner)">
|
|
|
984 <summary>
|
|
|
985 Read Id file
|
|
|
986 </summary>
|
|
|
987 </member>
|
|
|
988 <member name="T:LiteDB.DataPage">
|
|
|
989 <summary>
|
|
|
990 The DataPage thats stores object data.
|
|
|
991 </summary>
|
|
|
992 </member>
|
|
|
993 <member name="F:LiteDB.BasePage.PAGE_SIZE">
|
|
|
994 <summary>
|
|
|
995 The size of each page in disk - 4096 is NTFS default
|
|
|
996 </summary>
|
|
|
997 </member>
|
|
|
998 <member name="F:LiteDB.BasePage.PAGE_HEADER_SIZE">
|
|
|
999 <summary>
|
|
|
1000 This size is used bytes in header pages 17 bytes
|
|
|
1001 </summary>
|
|
|
1002 </member>
|
|
|
1003 <member name="F:LiteDB.BasePage.PAGE_AVAILABLE_BYTES">
|
|
|
1004 <summary>
|
|
|
1005 Bytes avaiable to store data removing page header size - 4079 bytes
|
|
|
1006 </summary>
|
|
|
1007 </member>
|
|
|
1008 <member name="M:LiteDB.BasePage.UpdateItemCount">
|
|
|
1009 <summary>
|
|
|
1010 Every page must imeplement this ItemCount + FreeBytes
|
|
|
1011 Must be called after Items are updates (insert/deletes) to keep variables ItemCount and FreeBytes synced
|
|
|
1012 </summary>
|
|
|
1013 </member>
|
|
|
1014 <member name="M:LiteDB.BasePage.Clear">
|
|
|
1015 <summary>
|
|
|
1016 Clear page content (using when delete a page)
|
|
|
1017 </summary>
|
|
|
1018 </member>
|
|
|
1019 <member name="M:LiteDB.BasePage.CopyTo``1">
|
|
|
1020 <summary>
|
|
|
1021 Create a new espefic page, copy all header content
|
|
|
1022 </summary>
|
|
|
1023 </member>
|
|
|
1024 <member name="P:LiteDB.BasePage.PageID">
|
|
|
1025 <summary>
|
|
|
1026 Represent page number - start in 0 with HeaderPage [4 bytes]
|
|
|
1027 </summary>
|
|
|
1028 </member>
|
|
|
1029 <member name="P:LiteDB.BasePage.PrevPageID">
|
|
|
1030 <summary>
|
|
|
1031 Represent the previous page. Used for page-sequences - MaxValue represent that has NO previous page [4 bytes]
|
|
|
1032 </summary>
|
|
|
1033 </member>
|
|
|
1034 <member name="P:LiteDB.BasePage.NextPageID">
|
|
|
1035 <summary>
|
|
|
1036 Represent the next page. Used for page-sequences - MaxValue represent that has NO next page [4 bytes]
|
|
|
1037 </summary>
|
|
|
1038 </member>
|
|
|
1039 <member name="P:LiteDB.BasePage.PageType">
|
|
|
1040 <summary>
|
|
|
1041 Indicate the page type [1 byte]
|
|
|
1042 </summary>
|
|
|
1043 </member>
|
|
|
1044 <member name="P:LiteDB.BasePage.ItemCount">
|
|
|
1045 <summary>
|
|
|
1046 Used for all pages to count itens inside this page(bytes, nodes, blocks, ...)
|
|
|
1047 Its Int32 but writes in UInt16
|
|
|
1048 </summary>
|
|
|
1049 </member>
|
|
|
1050 <member name="P:LiteDB.BasePage.FreeBytes">
|
|
|
1051 <summary>
|
|
|
1052 Used to find a free page using only header search [used in FreeList]
|
|
|
1053 Its Int32 but writes in UInt16
|
|
|
1054 Its updated when a page modify content length (add/remove items)
|
|
|
1055 </summary>
|
|
|
1056 </member>
|
|
|
1057 <member name="P:LiteDB.BasePage.IsDirty">
|
|
|
1058 <summary>
|
|
|
1059 Indicate that this page is dirty (was modified) and must persist when commited [not-persistable]
|
|
|
1060 </summary>
|
|
|
1061 </member>
|
|
|
1062 <member name="F:LiteDB.DataPage.DATA_RESERVED_BYTES">
|
|
|
1063 <summary>
|
|
|
1064 If a Data Page has less that free space, it's considered full page for new items. Can be used only for update (DataPage) ~ 50% PAGE_AVAILABLE_BYTES
|
|
|
1065 This value is used for minimize
|
|
|
1066 </summary>
|
|
|
1067 </member>
|
|
|
1068 <member name="M:LiteDB.DataPage.Clear">
|
|
|
1069 <summary>
|
|
|
1070 Clear page content - dataBlocks
|
|
|
1071 </summary>
|
|
|
1072 </member>
|
|
|
1073 <member name="M:LiteDB.DataPage.UpdateItemCount">
|
|
|
1074 <summary>
|
|
|
1075 Update freebytes + items count
|
|
|
1076 </summary>
|
|
|
1077 </member>
|
|
|
1078 <member name="P:LiteDB.DataPage.DataBlocks">
|
|
|
1079 <summary>
|
|
|
1080 Returns all data blocks - Each block has one object
|
|
|
1081 </summary>
|
|
|
1082 </member>
|
|
|
1083 <member name="F:LiteDB.IndexPage.INDEX_RESERVED_BYTES">
|
|
|
1084 <summary>
|
|
|
1085 If a Index Page has less that this free space, it's considered full page for new items.
|
|
|
1086 </summary>
|
|
|
1087 </member>
|
|
|
1088 <member name="M:LiteDB.IndexPage.Clear">
|
|
|
1089 <summary>
|
|
|
1090 Clear page content - nodes
|
|
|
1091 </summary>
|
|
|
1092 </member>
|
|
|
1093 <member name="M:LiteDB.IndexPage.UpdateItemCount">
|
|
|
1094 <summary>
|
|
|
1095 Update freebytes + items count
|
|
|
1096 </summary>
|
|
|
1097 </member>
|
|
|
1098 <member name="M:LiteDB.CollectionService.Get(System.String)">
|
|
|
1099 <summary>
|
|
|
1100 Get a exist collection. Returns null if not exists
|
|
|
1101 </summary>
|
|
|
1102 </member>
|
|
|
1103 <member name="M:LiteDB.CollectionService.Add(System.String)">
|
|
|
1104 <summary>
|
|
|
1105 Add a new collection. Check if name the not exists
|
|
|
1106 </summary>
|
|
|
1107 </member>
|
|
|
1108 <member name="M:LiteDB.CollectionService.GetAll">
|
|
|
1109 <summary>
|
|
|
1110 Get all collections
|
|
|
1111 </summary>
|
|
|
1112 </member>
|
|
|
1113 <member name="M:LiteDB.CollectionService.Drop(LiteDB.CollectionPage)">
|
|
|
1114 <summary>
|
|
|
1115 Drop a collection - remove all data pages + indexes pages
|
|
|
1116 </summary>
|
|
|
1117 </member>
|
|
|
1118 <member name="T:LiteDB.JournalService">
|
|
|
1119 <summary>
|
|
|
1120 Service to create a journal file to garantee write operations will be atomic
|
|
|
1121 </summary>
|
|
|
1122 </member>
|
|
|
1123 <member name="M:LiteDB.JournalService.WritePageInJournal(System.IO.BinaryWriter,LiteDB.BasePage)">
|
|
|
1124 <summary>
|
|
|
1125 Write a page in sequence, not in absolute position
|
|
|
1126 </summary>
|
|
|
1127 </member>
|
|
|
1128 <member name="T:LiteDB.RecoveryService">
|
|
|
1129 <summary>
|
|
|
1130 Service for restore datafile with there a problem when save on disk
|
|
|
1131 </summary>
|
|
|
1132 </member>
|
|
|
1133 <member name="T:LiteDB.IndexService">
|
|
|
1134 <summary>
|
|
|
1135 Implement a Index service - Add/Remove index nodes on SkipList
|
|
|
1136 Based on: http://igoro.com/archive/skip-lists-are-fascinating/
|
|
|
1137 </summary>
|
|
|
1138 </member>
|
|
|
1139 <member name="F:LiteDB.IndexService.MAX_INDEX_LENGTH">
|
|
|
1140 <summary>
|
|
|
1141 Max size of a index entry - usde for string, binary, array and documents
|
|
|
1142 </summary>
|
|
|
1143 </member>
|
|
|
1144 <member name="M:LiteDB.IndexService.CreateIndex(LiteDB.CollectionPage)">
|
|
|
1145 <summary>
|
|
|
1146 Create a new index and returns head page address (skip list)
|
|
|
1147 </summary>
|
|
|
1148 </member>
|
|
|
1149 <member name="M:LiteDB.IndexService.AddNode(LiteDB.CollectionIndex,LiteDB.BsonValue)">
|
|
|
1150 <summary>
|
|
|
1151 Insert a new node index inside an collection index. Flip coin to know level
|
|
|
1152 </summary>
|
|
|
1153 </member>
|
|
|
1154 <member name="M:LiteDB.IndexService.AddNode(LiteDB.CollectionIndex,LiteDB.BsonValue,System.Byte)">
|
|
|
1155 <summary>
|
|
|
1156 Insert a new node index inside an collection index.
|
|
|
1157 </summary>
|
|
|
1158 </member>
|
|
|
1159 <member name="M:LiteDB.IndexService.Delete(LiteDB.CollectionIndex,LiteDB.PageAddress)">
|
|
|
1160 <summary>
|
|
|
1161 Delete indexNode from a Index ajust Next/Prev nodes
|
|
|
1162 </summary>
|
|
|
1163 </member>
|
|
|
1164 <member name="M:LiteDB.IndexService.DropIndex(LiteDB.CollectionIndex)">
|
|
|
1165 <summary>
|
|
|
1166 Drop all indexes pages
|
|
|
1167 </summary>
|
|
|
1168 </member>
|
|
|
1169 <member name="M:LiteDB.IndexService.GetNode(LiteDB.PageAddress)">
|
|
|
1170 <summary>
|
|
|
1171 Get a node inside a page using PageAddress - Returns null if address IsEmpty
|
|
|
1172 </summary>
|
|
|
1173 </member>
|
|
|
1174 <member name="M:LiteDB.IndexService.FlipCoin">
|
|
|
1175 <summary>
|
|
|
1176 Flip coin - skip list - returns level node (start in 1)
|
|
|
1177 </summary>
|
|
|
1178 </member>
|
|
|
1179 <member name="M:LiteDB.IndexService.Find(LiteDB.CollectionIndex,LiteDB.BsonValue,System.Boolean,System.Int32)">
|
|
|
1180 <summary>
|
|
|
1181 Find first node that index match with value. If not found but sibling = true, returns near node (only non-unique index)
|
|
|
1182 Before find, value must be normalized
|
|
|
1183 </summary>
|
|
|
1184 </member>
|
|
|
1185 <member name="M:LiteDB.IndexService.FindBoundary(LiteDB.CollectionIndex,LiteDB.IndexNode,LiteDB.BsonValue,System.Int32,System.Int32)">
|
|
|
1186 <summary>
|
|
|
1187 Go first/last occurence of this index value
|
|
|
1188 </summary>
|
|
|
1189 </member>
|
|
|
1190 <member name="M:LiteDB.DataService.Insert(LiteDB.CollectionPage,System.Byte[])">
|
|
|
1191 <summary>
|
|
|
1192 Insert data inside a datapage. Returns dataPageID that idicates the first page
|
|
|
1193 </summary>
|
|
|
1194 </member>
|
|
|
1195 <member name="M:LiteDB.DataService.Update(LiteDB.CollectionPage,LiteDB.PageAddress,System.Byte[])">
|
|
|
1196 <summary>
|
|
|
1197 Update data inside a datapage. If new data can be used in same datapage, just update. Otherside, copy content to a new ExtendedPage
|
|
|
1198 </summary>
|
|
|
1199 </member>
|
|
|
1200 <member name="M:LiteDB.DataService.Read(LiteDB.PageAddress,System.Boolean)">
|
|
|
1201 <summary>
|
|
|
1202 Read all data from datafile using a pageID as reference. If data is not in DataPage, read from ExtendPage. If readExtendData = false, do not read extended data
|
|
|
1203 </summary>
|
|
|
1204 </member>
|
|
|
1205 <member name="M:LiteDB.DataService.ReadExtendData(System.UInt32)">
|
|
|
1206 <summary>
|
|
|
1207 Read all data from a extended page with all subsequences pages if exits
|
|
|
1208 </summary>
|
|
|
1209 </member>
|
|
|
1210 <member name="M:LiteDB.DataService.Delete(LiteDB.CollectionPage,LiteDB.PageAddress)">
|
|
|
1211 <summary>
|
|
|
1212 Delete one dataBlock
|
|
|
1213 </summary>
|
|
|
1214 </member>
|
|
|
1215 <member name="M:LiteDB.DataService.StoreExtendData(LiteDB.ExtendPage,System.Byte[])">
|
|
|
1216 <summary>
|
|
|
1217 Store all bytes in one extended page. If data ir bigger than a page, store in more pages and make all in sequence
|
|
|
1218 </summary>
|
|
|
1219 </member>
|
|
|
1220 <member name="T:LiteDB.CollectionPage">
|
|
|
1221 <summary>
|
|
|
1222 Represents the collection page AND a collection item, because CollectionPage represent a Collection (1 page = 1 collection). All collections pages are linked with Prev/Next links
|
|
|
1223 </summary>
|
|
|
1224 </member>
|
|
|
1225 <member name="F:LiteDB.CollectionPage.FreeDataPageID">
|
|
|
1226 <summary>
|
|
|
1227 Get a reference for the free list data page - its private list per collection - each DataPage contains only data for 1 collection (no mixing)
|
|
|
1228 Must to be a Field to be used as parameter reference
|
|
|
1229 </summary>
|
|
|
1230 </member>
|
|
|
1231 <member name="M:LiteDB.CollectionPage.GetFreeIndex">
|
|
|
1232 <summary>
|
|
|
1233 Returns first free index slot to be used
|
|
|
1234 </summary>
|
|
|
1235 </member>
|
|
|
1236 <member name="M:LiteDB.CollectionPage.GetIndex(System.String)">
|
|
|
1237 <summary>
|
|
|
1238 Get index from field name (index field name is case sensitive) - returns null if not found
|
|
|
1239 </summary>
|
|
|
1240 </member>
|
|
|
1241 <member name="M:LiteDB.CollectionPage.GetIndexes(System.Boolean)">
|
|
|
1242 <summary>
|
|
|
1243 Returns all used indexes
|
|
|
1244 </summary>
|
|
|
1245 </member>
|
|
|
1246 <member name="P:LiteDB.CollectionPage.CollectionName">
|
|
|
1247 <summary>
|
|
|
1248 Name of collection
|
|
|
1249 </summary>
|
|
|
1250 </member>
|
|
|
1251 <member name="P:LiteDB.CollectionPage.DocumentCount">
|
|
|
1252 <summary>
|
|
|
1253 Get the number of documents inside this collection
|
|
|
1254 </summary>
|
|
|
1255 </member>
|
|
|
1256 <member name="P:LiteDB.CollectionPage.Indexes">
|
|
|
1257 <summary>
|
|
|
1258 Get all indexes from this collection - includes non-used indexes
|
|
|
1259 </summary>
|
|
|
1260 </member>
|
|
|
1261 <member name="P:LiteDB.CollectionPage.PK">
|
|
|
1262 <summary>
|
|
|
1263 Get primary key index (_id index)
|
|
|
1264 </summary>
|
|
|
1265 </member>
|
|
|
1266 <member name="F:LiteDB.CollectionIndex.INDEX_PER_COLLECTION">
|
|
|
1267 <summary>
|
|
|
1268 Total indexes per collection - it's fixed because I will used fixed arrays allocations
|
|
|
1269 </summary>
|
|
|
1270 </member>
|
|
|
1271 <member name="F:LiteDB.CollectionIndex.FreeIndexPageID">
|
|
|
1272 <summary>
|
|
|
1273 Get a reference for the free list index page - its private list per collection/index (must be a Field to be used as reference parameter)
|
|
|
1274 </summary>
|
|
|
1275 </member>
|
|
|
1276 <member name="M:LiteDB.CollectionIndex.Clear">
|
|
|
1277 <summary>
|
|
|
1278 Clear all index information
|
|
|
1279 </summary>
|
|
|
1280 </member>
|
|
|
1281 <member name="P:LiteDB.CollectionIndex.Slot">
|
|
|
1282 <summary>
|
|
|
1283 Represent slot position on index array on dataBlock/collection indexes - non-persistable
|
|
|
1284 </summary>
|
|
|
1285 </member>
|
|
|
1286 <member name="P:LiteDB.CollectionIndex.Field">
|
|
|
1287 <summary>
|
|
|
1288 Field name
|
|
|
1289 </summary>
|
|
|
1290 </member>
|
|
|
1291 <member name="P:LiteDB.CollectionIndex.Options">
|
|
|
1292 <summary>
|
|
|
1293 Index options like unique and ignore case
|
|
|
1294 </summary>
|
|
|
1295 </member>
|
|
|
1296 <member name="P:LiteDB.CollectionIndex.HeadNode">
|
|
|
1297 <summary>
|
|
|
1298 Head page address for this index
|
|
|
1299 </summary>
|
|
|
1300 </member>
|
|
|
1301 <member name="P:LiteDB.CollectionIndex.TailNode">
|
|
|
1302 <summary>
|
|
|
1303 A link pointer to tail node
|
|
|
1304 </summary>
|
|
|
1305 </member>
|
|
|
1306 <member name="P:LiteDB.CollectionIndex.IsEmpty">
|
|
|
1307 <summary>
|
|
|
1308 Returns if this index slot is empty and can be used as new index
|
|
|
1309 </summary>
|
|
|
1310 </member>
|
|
|
1311 <member name="P:LiteDB.CollectionIndex.Page">
|
|
|
1312 <summary>
|
|
|
1313 Get a reference for page
|
|
|
1314 </summary>
|
|
|
1315 </member>
|
|
|
1316 <member name="T:LiteDB.IndexOptions">
|
|
|
1317 <summary>
|
|
|
1318 A class that represent all index options used on a index creation
|
|
|
1319 </summary>
|
|
|
1320 </member>
|
|
|
1321 <member name="P:LiteDB.IndexOptions.Unique">
|
|
|
1322 <summary>
|
|
|
1323 Unique keys?
|
|
|
1324 </summary>
|
|
|
1325 </member>
|
|
|
1326 <member name="P:LiteDB.IndexOptions.IgnoreCase">
|
|
|
1327 <summary>
|
|
|
1328 Ignore case? (convert all strings to lowercase)
|
|
|
1329 </summary>
|
|
|
1330 </member>
|
|
|
1331 <member name="P:LiteDB.IndexOptions.TrimWhitespace">
|
|
|
1332 <summary>
|
|
|
1333 Remove all whitespace on start/end string?
|
|
|
1334 </summary>
|
|
|
1335 </member>
|
|
|
1336 <member name="P:LiteDB.IndexOptions.EmptyStringToNull">
|
|
|
1337 <summary>
|
|
|
1338 Convert all empty string to null?
|
|
|
1339 </summary>
|
|
|
1340 </member>
|
|
|
1341 <member name="P:LiteDB.IndexOptions.RemoveAccents">
|
|
|
1342 <summary>
|
|
|
1343 Removing accents on string?
|
|
|
1344 </summary>
|
|
|
1345 </member>
|
|
|
1346 <member name="P:LiteDB.DataBlock.Position">
|
|
|
1347 <summary>
|
|
|
1348 Position of this dataBlock inside a page (store only Position.Index)
|
|
|
1349 </summary>
|
|
|
1350 </member>
|
|
|
1351 <member name="P:LiteDB.DataBlock.IndexRef">
|
|
|
1352 <summary>
|
|
|
1353 Indexes nodes for all indexes for this data block
|
|
|
1354 </summary>
|
|
|
1355 </member>
|
|
|
1356 <member name="P:LiteDB.DataBlock.ExtendPageID">
|
|
|
1357 <summary>
|
|
|
1358 If object is bigger than this page - use a ExtendPage (and do not use Data array)
|
|
|
1359 </summary>
|
|
|
1360 </member>
|
|
|
1361 <member name="P:LiteDB.DataBlock.Data">
|
|
|
1362 <summary>
|
|
|
1363 Data of a record - could be empty if is used in ExtedPage
|
|
|
1364 </summary>
|
|
|
1365 </member>
|
|
|
1366 <member name="P:LiteDB.DataBlock.Page">
|
|
|
1367 <summary>
|
|
|
1368 Get a reference for page
|
|
|
1369 </summary>
|
|
|
1370 </member>
|
|
|
1371 <member name="P:LiteDB.DataBlock.Length">
|
|
|
1372 <summary>
|
|
|
1373 Get length of this dataBlock - not persistable
|
|
|
1374 </summary>
|
|
|
1375 </member>
|
|
|
1376 <member name="P:LiteDB.DataBlock.ExtendData">
|
|
|
1377 <summary>
|
|
|
1378 Represent data from Extend Pages - not persistable and used only when load data
|
|
|
1379 </summary>
|
|
|
1380 </member>
|
|
|
1381 <member name="P:LiteDB.DataBlock.Buffer">
|
|
|
1382 <summary>
|
|
|
1383 A readonly property (non-persistable) that contains data from this page OR from Extended Pages
|
|
|
1384 </summary>
|
|
|
1385 </member>
|
|
|
1386 <member name="T:LiteDB.IndexNode">
|
|
|
1387 <summary>
|
|
|
1388 Represent a index node inside a Index Page
|
|
|
1389 </summary>
|
|
|
1390 </member>
|
|
|
1391 <member name="F:LiteDB.IndexNode.MAX_LEVEL_LENGTH">
|
|
|
1392 <summary>
|
|
|
1393 Max level used on skip list
|
|
|
1394 </summary>
|
|
|
1395 </member>
|
|
|
1396 <member name="M:LiteDB.IndexNode.NextPrev(System.Int32,System.Int32)">
|
|
|
1397 <summary>
|
|
|
1398 Returns Next (order == 1) OR Prev (order == -1)
|
|
|
1399 </summary>
|
|
|
1400 </member>
|
|
|
1401 <member name="M:LiteDB.IndexNode.IsHeadTail(LiteDB.CollectionIndex)">
|
|
|
1402 <summary>
|
|
|
1403 Returns if this node is header or tail from collection Index
|
|
|
1404 </summary>
|
|
|
1405 <param name="index"></param>
|
|
|
1406 <returns></returns>
|
|
|
1407 </member>
|
|
|
1408 <member name="P:LiteDB.IndexNode.Position">
|
|
|
1409 <summary>
|
|
|
1410 Position of this node inside a IndexPage - Store only Position.Index
|
|
|
1411 </summary>
|
|
|
1412 </member>
|
|
|
1413 <member name="P:LiteDB.IndexNode.Prev">
|
|
|
1414 <summary>
|
|
|
1415 Pointer to prev value (used in skip lists - Prev.Length = Next.Length)
|
|
|
1416 </summary>
|
|
|
1417 </member>
|
|
|
1418 <member name="P:LiteDB.IndexNode.Next">
|
|
|
1419 <summary>
|
|
|
1420 Pointer to next value (used in skip lists - Prev.Length = Next.Length)
|
|
|
1421 </summary>
|
|
|
1422 </member>
|
|
|
1423 <member name="P:LiteDB.IndexNode.KeyLength">
|
|
|
1424 <summary>
|
|
|
1425 Length of key - used for calculate Node size
|
|
|
1426 </summary>
|
|
|
1427 </member>
|
|
|
1428 <member name="P:LiteDB.IndexNode.Key">
|
|
|
1429 <summary>
|
|
|
1430 The object value that was indexed
|
|
|
1431 </summary>
|
|
|
1432 </member>
|
|
|
1433 <member name="P:LiteDB.IndexNode.DataBlock">
|
|
|
1434 <summary>
|
|
|
1435 Reference for a datablock - the value
|
|
|
1436 </summary>
|
|
|
1437 </member>
|
|
|
1438 <member name="P:LiteDB.IndexNode.Page">
|
|
|
1439 <summary>
|
|
|
1440 Get page reference
|
|
|
1441 </summary>
|
|
|
1442 </member>
|
|
|
1443 <member name="P:LiteDB.IndexNode.Length">
|
|
|
1444 <summary>
|
|
|
1445 Get the length size of this node in disk - not persistable
|
|
|
1446 </summary>
|
|
|
1447 </member>
|
|
|
1448 <member name="T:LiteDB.PageAddress">
|
|
|
1449 <summary>
|
|
|
1450 Represents a page adress inside a page structure - index could be byte offset position OR index in a list
|
|
|
1451 </summary>
|
|
|
1452 </member>
|
|
|
1453 <member name="T:LiteDB.ExtendPage">
|
|
|
1454 <summary>
|
|
|
1455 Represent a extra data page that contains the object when is not possible store in DataPage (bigger then PAGE_SIZE or on update has no more space on page)
|
|
|
1456 Can be used in sequence of pages to store big objects
|
|
|
1457 </summary>
|
|
|
1458 </member>
|
|
|
1459 <member name="M:LiteDB.ExtendPage.Clear">
|
|
|
1460 <summary>
|
|
|
1461 Clear page content - Data byte array
|
|
|
1462 </summary>
|
|
|
1463 </member>
|
|
|
1464 <member name="M:LiteDB.ExtendPage.UpdateItemCount">
|
|
|
1465 <summary>
|
|
|
1466 Update freebytes + items count
|
|
|
1467 </summary>
|
|
|
1468 </member>
|
|
|
1469 <member name="P:LiteDB.ExtendPage.Data">
|
|
|
1470 <summary>
|
|
|
1471 Represent the part or full of the object - if this page has NextPageID the object is bigger than this page
|
|
|
1472 </summary>
|
|
|
1473 </member>
|
|
|
1474 <member name="T:LiteDB.CacheService">
|
|
|
1475 <summary>
|
|
|
1476 Represent all cache system and track dirty pages. All pages that load and need to be track for
|
|
|
1477 dirty (to be persist after) must be added in this class.
|
|
|
1478 </summary>
|
|
|
1479 </member>
|
|
|
1480 <member name="M:LiteDB.CacheService.GetPage``1(System.UInt32)">
|
|
|
1481 <summary>
|
|
|
1482 Get a page inside cache system. Returns null if page not existis.
|
|
|
1483 If T is more specific than page that I have in cache, returns null (eg. Page 2 is BasePage in cache and this method call for IndexPage PageId 2)
|
|
|
1484 </summary>
|
|
|
1485 </member>
|
|
|
1486 <member name="M:LiteDB.CacheService.AddPage(LiteDB.BasePage)">
|
|
|
1487 <summary>
|
|
|
1488 Add a page to cache. if this page is in cache, override (except if is basePage - in this case, copy header)
|
|
|
1489 </summary>
|
|
|
1490 </member>
|
|
|
1491 <member name="M:LiteDB.CacheService.Clear(LiteDB.HeaderPage)">
|
|
|
1492 <summary>
|
|
|
1493 Empty cache and header page
|
|
|
1494 </summary>
|
|
|
1495 </member>
|
|
|
1496 <member name="M:LiteDB.CacheService.RemoveExtendPages">
|
|
|
1497 <summary>
|
|
|
1498 Remove from cache only extend pages - useful for FileStorage
|
|
|
1499 </summary>
|
|
|
1500 </member>
|
|
|
1501 <member name="M:LiteDB.CacheService.PersistDirtyPages">
|
|
|
1502 <summary>
|
|
|
1503 Persist all dirty pages
|
|
|
1504 </summary>
|
|
|
1505 </member>
|
|
|
1506 <member name="M:LiteDB.CacheService.HasDirtyPages">
|
|
|
1507 <summary>
|
|
|
1508 Checks if cache has dirty pages
|
|
|
1509 </summary>
|
|
|
1510 </member>
|
|
|
1511 <member name="M:LiteDB.CacheService.GetDirtyPages">
|
|
|
1512 <summary>
|
|
|
1513 Returns all dirty pages including header page (for better write performance, get all pages in PageID increase order)
|
|
|
1514 </summary>
|
|
|
1515 </member>
|
|
|
1516 <member name="P:LiteDB.CacheService.PagesInCache">
|
|
|
1517 <summary>
|
|
|
1518 Gets total pages in cache for database info
|
|
|
1519 </summary>
|
|
|
1520 </member>
|
|
|
1521 <member name="P:LiteDB.CacheService.Header">
|
|
|
1522 <summary>
|
|
|
1523 Get header page in cache or request for a new instance if not existis yet
|
|
|
1524 </summary>
|
|
|
1525 </member>
|
|
|
1526 <member name="M:LiteDB.PageService.GetPage``1(System.UInt32)">
|
|
|
1527 <summary>
|
|
|
1528 Get a page from cache or from disk (and put on cache)
|
|
|
1529 </summary>
|
|
|
1530 </member>
|
|
|
1531 <member name="M:LiteDB.PageService.GetSeqPages``1(System.UInt32)">
|
|
|
1532 <summary>
|
|
|
1533 Read all sequences pages from a start pageID (using NextPageID)
|
|
|
1534 </summary>
|
|
|
1535 </member>
|
|
|
1536 <member name="M:LiteDB.PageService.NewPage``1(LiteDB.BasePage)">
|
|
|
1537 <summary>
|
|
|
1538 Get a new empty page - can be a reused page (EmptyPage) or a clean one (extend datafile)
|
|
|
1539 </summary>
|
|
|
1540 </member>
|
|
|
1541 <member name="M:LiteDB.PageService.DeletePage(System.UInt32,System.Boolean)">
|
|
|
1542 <summary>
|
|
|
1543 Delete an page using pageID - transform them in Empty Page and add to EmptyPageList
|
|
|
1544 </summary>
|
|
|
1545 </member>
|
|
|
1546 <member name="M:LiteDB.PageService.GetFreePage``1(System.UInt32,System.Int32)">
|
|
|
1547 <summary>
|
|
|
1548 Returns a page that contains space enouth to data to insert new object - if not exits, create a new Page
|
|
|
1549 </summary>
|
|
|
1550 </member>
|
|
|
1551 <member name="M:LiteDB.PageService.AddOrRemoveToFreeList(System.Boolean,LiteDB.BasePage,LiteDB.BasePage,System.UInt32@)">
|
|
|
1552 <summary>
|
|
|
1553 Add or Remove a page in a sequence
|
|
|
1554 </summary>
|
|
|
1555 <param name="add">Indicate that will add or remove from FreeList</param>
|
|
|
1556 <param name="page">Page to add or remove from FreeList</param>
|
|
|
1557 <param name="startPage">Page reference where start the header list node</param>
|
|
|
1558 <param name="fieldPageID">Field reference, from startPage</param>
|
|
|
1559 </member>
|
|
|
1560 <member name="M:LiteDB.PageService.AddToFreeList(LiteDB.BasePage,LiteDB.BasePage,System.UInt32@)">
|
|
|
1561 <summary>
|
|
|
1562 Add a page in free list in desc free size order
|
|
|
1563 </summary>
|
|
|
1564 </member>
|
|
|
1565 <member name="M:LiteDB.PageService.RemoveToFreeList(LiteDB.BasePage,LiteDB.BasePage,System.UInt32@)">
|
|
|
1566 <summary>
|
|
|
1567 Remove a page from list - the ease part
|
|
|
1568 </summary>
|
|
|
1569 </member>
|
|
|
1570 <member name="M:LiteDB.PageService.MoveToFreeList(LiteDB.BasePage,LiteDB.BasePage,System.UInt32@)">
|
|
|
1571 <summary>
|
|
|
1572 When a page is already on a list it's more efficient just move comparing with sinblings
|
|
|
1573 </summary>
|
|
|
1574 </member>
|
|
|
1575 <member name="M:LiteDB.DiskService.CreateNewDatafile(LiteDB.ConnectionString)">
|
|
|
1576 <summary>
|
|
|
1577 Create a empty database ready to be used using connectionString as parameters
|
|
|
1578 </summary>
|
|
|
1579 </member>
|
|
|
1580 <member name="M:LiteDB.DiskService.ReadPage``1(System.UInt32)">
|
|
|
1581 <summary>
|
|
|
1582 Create a new Page instance and read data from disk
|
|
|
1583 </summary>
|
|
|
1584 </member>
|
|
|
1585 <member name="M:LiteDB.DiskService.WritePage(LiteDB.BasePage)">
|
|
|
1586 <summary>
|
|
|
1587 Write a page from memory to disk
|
|
|
1588 </summary>
|
|
|
1589 </member>
|
|
|
1590 <member name="M:LiteDB.DiskService.WritePage(System.IO.BinaryWriter,LiteDB.BasePage)">
|
|
|
1591 <summary>
|
|
|
1592 Static method for write a page using a diferent writer - used when create empty datafile
|
|
|
1593 </summary>
|
|
|
1594 </member>
|
|
|
1595 <member name="M:LiteDB.DiskService.AllocateDiskSpace(System.Int64)">
|
|
|
1596 <summary>
|
|
|
1597 Pre-allocate more disk space to fast write new pages on disk
|
|
|
1598 </summary>
|
|
|
1599 </member>
|
|
|
1600 <member name="M:LiteDB.DiskService.GetWriter">
|
|
|
1601 <summary>
|
|
|
1602 Get BinaryWriter
|
|
|
1603 </summary>
|
|
|
1604 </member>
|
|
|
1605 <member name="M:LiteDB.DiskService.Lock">
|
|
|
1606 <summary>
|
|
|
1607 Lock the datafile when start a begin transaction
|
|
|
1608 </summary>
|
|
|
1609 </member>
|
|
|
1610 <member name="M:LiteDB.DiskService.UnLock">
|
|
|
1611 <summary>
|
|
|
1612 Unlock the datafile
|
|
|
1613 </summary>
|
|
|
1614 </member>
|
|
|
1615 <member name="M:LiteDB.DiskService.ProtectWriteFile(System.Action)">
|
|
|
1616 <summary>
|
|
|
1617 Lock all file during write operations - avoid reads during inconsistence data
|
|
|
1618 </summary>
|
|
|
1619 </member>
|
|
|
1620 <member name="M:LiteDB.DiskService.TryExec(System.TimeSpan,System.Action)">
|
|
|
1621 <summary>
|
|
|
1622 Try execute a block of code until timeout when IO lock exception occurs OR access denind
|
|
|
1623 </summary>
|
|
|
1624 </member>
|
|
|
1625 <member name="T:LiteDB.TransactionService">
|
|
|
1626 <summary>
|
|
|
1627 Manage all transaction and garantee concurrency and recovery
|
|
|
1628 </summary>
|
|
|
1629 </member>
|
|
|
1630 <member name="M:LiteDB.TransactionService.Begin">
|
|
|
1631 <summary>
|
|
|
1632 Starts a new transaction - lock database to garantee that only one processes is in a transaction
|
|
|
1633 </summary>
|
|
|
1634 </member>
|
|
|
1635 <member name="M:LiteDB.TransactionService.Abort">
|
|
|
1636 <summary>
|
|
|
1637 Abort a transaction is used when begin and has no changes yet - no writes, no checks
|
|
|
1638 </summary>
|
|
|
1639 </member>
|
|
|
1640 <member name="M:LiteDB.TransactionService.Commit">
|
|
|
1641 <summary>
|
|
|
1642 Commit the transaction - increese
|
|
|
1643 </summary>
|
|
|
1644 </member>
|
|
|
1645 <member name="M:LiteDB.TransactionService.AvoidDirtyRead">
|
|
|
1646 <summary>
|
|
|
1647 This method must be called before read operation to avoid dirty reads.
|
|
|
1648 It's occurs when my cache contains pages that was changed in another process
|
|
|
1649 </summary>
|
|
|
1650 </member>
|
|
|
1651 <member name="T:LiteDB.ConnectionString">
|
|
|
1652 <summary>
|
|
|
1653 Manage ConnectionString to connect and create databases. Can be used as:
|
|
|
1654 * If only a word - get from App.Config
|
|
|
1655 * If is a path - use all parameters as default
|
|
|
1656 * Otherwise, is name=value collection
|
|
|
1657 </summary>
|
|
|
1658 </member>
|
|
|
1659 <member name="P:LiteDB.ConnectionString.Filename">
|
|
|
1660 <summary>
|
|
|
1661 Path of filename (no default - required key)
|
|
|
1662 </summary>
|
|
|
1663 </member>
|
|
|
1664 <member name="P:LiteDB.ConnectionString.Timeout">
|
|
|
1665 <summary>
|
|
|
1666 Default Timeout connection to wait for unlock (default: 1 minute)
|
|
|
1667 </summary>
|
|
|
1668 </member>
|
|
|
1669 <member name="P:LiteDB.ConnectionString.JournalEnabled">
|
|
|
1670 <summary>
|
|
|
1671 Supports recovery mode if a fail during write pages to disk
|
|
|
1672 </summary>
|
|
|
1673 </member>
|
|
|
1674 <member name="P:LiteDB.ConnectionString.JournalFilename">
|
|
|
1675 <summary>
|
|
|
1676 Jounal filename with full path
|
|
|
1677 </summary>
|
|
|
1678 </member>
|
|
|
1679 <member name="P:LiteDB.ConnectionString.UserVersion">
|
|
|
1680 <summary>
|
|
|
1681 Define, in connection string, the user database version. When you increse this value
|
|
|
1682 LiteDatabase will run OnUpdate method for each new version. If defined, must be >= 1. Default: 1
|
|
|
1683 </summary>
|
|
|
1684 </member>
|
|
|
1685 <member name="F:LiteDB.HeaderPage.HEADER_INFO">
|
|
|
1686 <summary>
|
|
|
1687 Header info the validate that datafile is a LiteDB file
|
|
|
1688 </summary>
|
|
|
1689 </member>
|
|
|
1690 <member name="F:LiteDB.HeaderPage.FILE_VERSION">
|
|
|
1691 <summary>
|
|
|
1692 Datafile specification version
|
|
|
1693 </summary>
|
|
|
1694 </member>
|
|
|
1695 <member name="F:LiteDB.HeaderPage.FreeEmptyPageID">
|
|
|
1696 <summary>
|
|
|
1697 Get/Set the pageID that start sequenece with a complete empty pages (can be used as a new page)
|
|
|
1698 </summary>
|
|
|
1699 </member>
|
|
|
1700 <member name="F:LiteDB.HeaderPage.FirstCollectionPageID">
|
|
|
1701 <summary>
|
|
|
1702 Get/Set the first collection pageID (used as Field to be passed as reference)
|
|
|
1703 </summary>
|
|
|
1704 </member>
|
|
|
1705 <member name="P:LiteDB.HeaderPage.ChangeID">
|
|
|
1706 <summary>
|
|
|
1707 Get/Set the changeID of data. When a client read pages, all pages are in the same version. But when OpenTransaction, we need validade that current changeID is the sabe that we have in cache
|
|
|
1708 </summary>
|
|
|
1709 </member>
|
|
|
1710 <member name="P:LiteDB.HeaderPage.LastPageID">
|
|
|
1711 <summary>
|
|
|
1712 Last created page - Used when there is no free page inside file
|
|
|
1713 </summary>
|
|
|
1714 </member>
|
|
|
1715 <member name="P:LiteDB.HeaderPage.UserVersion">
|
|
|
1716 <summary>
|
|
|
1717 Get/Set a user version of database file
|
|
|
1718 </summary>
|
|
|
1719 </member>
|
|
|
1720 <member name="T:LiteDB.DumpDatabase">
|
|
|
1721 <summary>
|
|
|
1722 A debugger class to show how pages are storaged. Used to debug pages in shell/tests
|
|
|
1723 </summary>
|
|
|
1724 </member>
|
|
|
1725 <member name="T:LiteDB.MimeTypeConverter">
|
|
|
1726 <summary>
|
|
|
1727 Convert filename to mimetype (http://stackoverflow.com/questions/1029740/get-mime-type-from-filename-extension)
|
|
|
1728 </summary>
|
|
|
1729 </member>
|
|
|
1730 <member name="T:LiteDB.LiteException">
|
|
|
1731 <summary>
|
|
|
1732 The main exception for LiteDB
|
|
|
1733 </summary>
|
|
|
1734 </member>
|
|
|
1735 <member name="T:LiteDB.StringScanner">
|
|
|
1736 <summary>
|
|
|
1737 A StringScanner is state machine used in text parsers based on regular expressions
|
|
|
1738 </summary>
|
|
|
1739 </member>
|
|
|
1740 <member name="M:LiteDB.StringScanner.#ctor(System.String)">
|
|
|
1741 <summary>
|
|
|
1742 Initialize scanner with a string to be parsed
|
|
|
1743 </summary>
|
|
|
1744 </member>
|
|
|
1745 <member name="M:LiteDB.StringScanner.Reset">
|
|
|
1746 <summary>
|
|
|
1747 Reset cursor position
|
|
|
1748 </summary>
|
|
|
1749 </member>
|
|
|
1750 <member name="M:LiteDB.StringScanner.Seek(System.Int32)">
|
|
|
1751 <summary>
|
|
|
1752 Skip cursor position in string source
|
|
|
1753 </summary>
|
|
|
1754 </member>
|
|
|
1755 <member name="M:LiteDB.StringScanner.Scan(System.String)">
|
|
|
1756 <summary>
|
|
|
1757 Scan in current cursor position for this patterns. If found, returns string and run with cursor
|
|
|
1758 </summary>
|
|
|
1759 </member>
|
|
|
1760 <member name="M:LiteDB.StringScanner.Scan(System.Text.RegularExpressions.Regex)">
|
|
|
1761 <summary>
|
|
|
1762 Scan in current cursor position for this patterns. If found, returns string and run with cursor
|
|
|
1763 </summary>
|
|
|
1764 </member>
|
|
|
1765 <member name="M:LiteDB.StringScanner.Scan(System.String,System.Int32)">
|
|
|
1766 <summary>
|
|
|
1767 Scan pattern and returns group string index 1 based
|
|
|
1768 </summary>
|
|
|
1769 </member>
|
|
|
1770 <member name="M:LiteDB.StringScanner.Match(System.String)">
|
|
|
1771 <summary>
|
|
|
1772 Match if pattern is true in current cursor position. Do not change cursor position
|
|
|
1773 </summary>
|
|
|
1774 </member>
|
|
|
1775 <member name="M:LiteDB.StringScanner.Match(System.Text.RegularExpressions.Regex)">
|
|
|
1776 <summary>
|
|
|
1777 Match if pattern is true in current cursor position. Do not change cursor position
|
|
|
1778 </summary>
|
|
|
1779 </member>
|
|
|
1780 <member name="P:LiteDB.StringScanner.HasTerminated">
|
|
|
1781 <summary>
|
|
|
1782 Indicate that cursor is EOF
|
|
|
1783 </summary>
|
|
|
1784 </member>
|
|
|
1785 </members>
|
|
|
1786 </doc>
|
