---
title: "ReadMongo"
slug: "readmongo"
updated: 2025-01-30T15:57:07Z
published: 2025-01-30T15:57:07Z
canonical: "docs.datajet.app/readmongo"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.datajet.app/llms.txt
> Use this file to discover all available pages before exploring further.

# ReadMongo

Reads stored details for an object from mongo

| Key | Value(s) | Description |
| --- | --- | --- |
| method | "ReadMongo" | Reads stored details for an object from mongo |
| query | { "name":"ObjectName" "table": "" } | table is optional, provide it if there is more than one object with specified name |
|  | { "class": "BJoin" } | other values: - BJoin - BField - BTable - ... |

TipDrag a field object from project explorer and drop into [Runner](/v1/docs/runner).   Press Run.   Detailed field information will be displayed for the object.

This method is designed to be used in Runner by administrators.

Possible Return Values

| Key | Value(s) | Description |
| --- | --- | --- |
| class | "ClassName" | e.g. BField |
| table | "TableName" | owner table of field |
| sourceField{} | {} | Field Properties and data type |
| creator{} | {} | Details of method used to create field |
| method | "MethodName" | Method used to build field (e.g., BuildBakedField, Imported etc) |
| tag |  |  |
| unique | -1 | Count of unique values. May be -1 if field is continuous and discrete values have not been explicitly counted |
| isPII | true/false | Whether or not the field's data is viewable. |
| hidden | true/false | Whether or not field is visible. |
| buildEpoch |  |  |
| sortOrder |  |  |
| atomicSourceFields[] | [] | List of atomic source fields used in the creation of the object |
| properties{} | {} | Metadata properties, as set using [SetPropertiesFromWorkbook](/v1/docs/setpropertiesfromworkbook) and SetObjectProperty |
| name | "ShortFieldName" | field name |
| description | "Description" | Description of field |
| user | "UserName" | Name of user who created data file |
| fileStub | "fileStub" | unique identifier of underlying data file |
| injected | true/false | If true, field has been injected (i.e., the source data is in another project, and potentially on another realm) |
| generation |  |  |
| deleteProtect | true/false | If true, the field is protected from deletion |
| hideInTree | true/false | If true, field will not appear in Project Explorer |
| version | VersionNo | Version of middleware that built the data file (DatajetServer.exe) |
| machineName |  | Machine that built the data file |
| puid |  | Package ID of source package(s). If field has been injected through multiple packages, all package IDs will be listed. |
| homepath |  | Full path to the folder containing the data files for the field |
| injectedPackageName |  | Name of package containing the object |
| injectedPackageParents[] |  | List of any additional ancestor packages used by field |
| executed | true/false |  |
| errors[] |  |  |
| millis |  |  |
| projectEpoch |  |  |
| method |  |  |
| exmillis |  |  |

```json
{
  "method": "ReadMongo",
  "query": {
    "class": "BJoin"
  }
}
```

```json
{
  "method": "ReadMongo",
  "query": {
    "name": "currenthouseholdkey",
    "table": "DATA_SRC",
    "class": "BField"
  }
}
```

```json
{
  "method": "ReadMongo",
  "query": {
    "name": "currentaddresskey"
  }
}

RETURN:

{
  "entries": [
    {
      "class": "BField",
      "table": "Base1_AWIData_Foreign",
      "sourceField": {
        "class": "BSourceField",
        "name": "currentaddresskey",
        "type": "continuous",
        "dataType": "longinteger",
        "size": "long",
        "length": 0
      },
      "creator": {},
      "method": "",
      "tag": "",
      "unique": -1,
      "isPII": false,
      "hidden": false,
      "buildEpoch": 0,
      "sortOrder": [],
      "atomicSourceFields": [
        "DATA_SRC.key"
      ],
      "name": "currentaddresskey",
      "description": "",
      "user": "s@dsoft.com",
      "fileStub": "file_638688000428711255_2083",
      "injected": false,
      "generation": 0,
      "deleteProtect": false,
      "hideInTree": false,
      "version": "268401.267701",
      "metaData": {},
      "Displayname": "Current Address Key",
      "MetadataType": "",
      "Code": "99082",
      "Allant ID": "99082",
      "Categories": "Address",
      "Value Type": "None",
      "DSARDelete": "Y",
      "DisplayText": "(99082) Current Address Key",
      "homePath": "/.../[server_name]/u02/engine/repos/[realm_name]/[project_name]/"
    }
  ],
  "executed": true,
  "errors": [],
  "millis": 1,
  "projectEpoch": 638688001405169072,
  "method": "ReadMongo",
  "exmillis": 5
}
```