Commands: Documents: Get

Get can be used to retrieve a single document.

Syntax

JsonDocument Get(string key);

Example

JsonDocument document = store.DatabaseCommands.Get("products/1"); // null if does not exist

Get can also be used to retrieve a list of documents.

Syntax

MultiLoadResult Get(
	string[] ids,
	string[] includes,
	string transformer = null,
	Dictionary<string, RavenJToken> transformerParameters = null,
	bool metadataOnly = false);

public class MultiLoadResult
{
	public List<RavenJObject> Results { get; set; }

	public List<RavenJObject> Includes { get; set; }
}

Example I

MultiLoadResult resultsWithoutIncludes = store
	.DatabaseCommands
	.Get(new[] { "products/1", "products/2" }, null);

Example II - using includes

MultiLoadResult resultsWithIncludes = store
	.DatabaseCommands
	.Get(
		new[] { "products/1", "products/2" },
		new[] { "Category" });

List<RavenJObject> results = resultsWithIncludes.Results; // products/1, products/2
List<RavenJObject> includes = resultsWithIncludes.Includes; // categories/1

Example III - missing documents

// assuming that 'products/9999' does not exist
MultiLoadResult resultsWithIncludes = store
	.DatabaseCommands
	.Get(
		new[] { "products/1", "products/9999", "products/3" },
		null);

List<RavenJObject> results = resultsWithIncludes.Results; // products/1, null, products/3
List<RavenJObject> includes = resultsWithIncludes.Includes; // empty

GetDocuments can be used to retrieve multiple documents.

Syntax

JsonDocument[] GetDocuments(int start, int pageSize, bool metadataOnly = false);

Example

JsonDocument[] documents = store.DatabaseCommands.GetDocuments(0, 10, metadataOnly: false);

StartsWith can be used to retrieve multiple documents for a specified key prefix.

Syntax

JsonDocument[] StartsWith(
	string keyPrefix, 
	string matches,
	int start,
	int pageSize,
	RavenPagingInformation pagingInformation = null,
	bool metadataOnly = false,
	string exclude = null,
	string transformer = null,
	Dictionary<string, RavenJToken> transformerParameters = null,
	string skipAfter = null);

Example I

// return up to 128 documents with key that starts with 'products'
JsonDocument[] result = store.DatabaseCommands.StartsWith("products", null, 0, 128);

Example II

// return up to 128 documents with key that starts with 'products/' 
// and rest of the key begins with "1" or "2" e.g. products/10, products/25
JsonDocument[] result = store.DatabaseCommands.StartsWith("products/", "1*|2*", 0, 128); 

Example III

// return up to 128 documents with key that starts with 'products/' 
// and rest of the key have length of 3, begins and ends with "1" 
// and contains any character at 2nd position e.g. products/101, products/1B1
JsonDocument[] result = store.DatabaseCommands.StartsWith("products/", "1?1", 0, 128);