Commands: Documents: Get

Get can be used to retrieve a single document.

Syntax

public JsonDocument get(String key);

Example

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

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

Syntax

public MultiLoadResult get(String[] ids, String[] includes);

public MultiLoadResult get(String[] ids, String[] includes, String transformer);

public MultiLoadResult get(String[] ids, String[] includes, String transformer, Map<String, RavenJToken> transformerParameters);

public MultiLoadResult get(String[] ids, String[] includes, String transformer, Map<String, RavenJToken> transformerParameters, boolean metadataOnly);

public class MultiLoadResult
{
  private List<RavenJObject> results;
  private List<RavenJObject> includes;

  public List<RavenJObject> getResults() {
    return results;
  }

  public void setResults(List<RavenJObject> results) {
    this.results = results;
  }

  public List<RavenJObject> getIncludes() {
    return includes;
  }

  public void setIncludes(List<RavenJObject> includes) {
    this.includes = includes;
  }
}

Example I

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

Example II - using includes

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

List<RavenJObject> results = resultsWithIncludes.getResults(); // products/1, products/2
List<RavenJObject> includes = resultsWithIncludes.getIncludes(); // categories/1

Example III - missing documents

// assuming that 'products/9999' does not exist
MultiLoadResult resultsWithIncludes = store.getDatabaseCommands().get(
  new String[] { "products/1", "products/9999", "products/3" },
  null
  );
List<RavenJObject> results = resultsWithIncludes.getResults(); // products/1, null, products/3
List<RavenJObject> includes = resultsWithIncludes.getIncludes(); // empty

GetDocuments can be used to retrieve multiple documents.

Syntax

public List<JsonDocument> getDocuments(int start, int pageSize);

public List<JsonDocument> getDocuments(int start, int pageSize, boolean metadataOnly);

Example

List<JsonDocument> documents = store.getDatabaseCommands().getDocuments(0, 10, false);

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

Syntax

public List<JsonDocument> startsWith(String keyPrefix, String matches, int start, int pageSize);

public List<JsonDocument> startsWith(String keyPrefix, String matches, int start, int pageSize, boolean metadataOnly);

public List<JsonDocument> startsWith(String keyPrefix, String matches, int start, int pageSize, boolean metadataOnly, String exclude);

public List<JsonDocument> startsWith(String keyPrefix, String matches, int start, int pageSize, boolean metadataOnly, String exclude, RavenPagingInformation pagingInformation);

public List<JsonDocument> startsWith(String keyPrefix, String matches, int start, int pageSize, boolean metadataOnly,
  String exclude, RavenPagingInformation pagingInformation, String transformer, Map<String, RavenJToken> transformerParameters);

public List<JsonDocument> startsWith(String keyPrefix, String matches, int start, int pageSize, boolean metadataOnly,
  String exclude, RavenPagingInformation pagingInformation, String transformer, Map<String, RavenJToken> transformerParameters, String skipAfter);

Example I

// return up to 128 documents with key that starts with 'products'
List<JsonDocument> result = store.getDatabaseCommands().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
List<JsonDocument> result = store.getDatabaseCommands().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
List<JsonDocument> result = store.getDatabaseCommands().startsWith("products/", "1?1", 0, 128);