Skip to main content

Commands: Documents: How to Get Document Metadata Only

GetDocumentsCommand can be used to retrieve the metadata of documents.

Syntax​

public GetDocumentsCommand(string id, string[] includes, bool metadataOnly)
public GetDocumentsCommand(string[] ids, string[] includes, bool metadataOnly)
Parameters
id / idsstring / string[]IDs of documents to get metadata for
includesstringRelated documents to fetch along with the document
metadataOnlybooleanWhether to fetch the whole document or just the metadata.

Example​

var command = new GetDocumentsCommand("orders/1-A", null, metadataOnly: true);
session.Advanced.RequestExecutor.Execute(command, session.Advanced.Context);
var result = (BlittableJsonReaderObject)command.Result.Results[0];
var documentMetadata = (BlittableJsonReaderObject)result["@metadata"];

// Print out all the metadata properties.
foreach (var propertyName in documentMetadata.GetPropertyNames())
{
  documentMetadata.TryGet<object>(propertyName, out var metaPropValue);
  Console.WriteLine("{0} = {1}", propertyName, metaPropValue);
}