FQL v4 will be decommissioned on June 30, 2025. Ensure that you complete your migration from FQL v4 to FQL v10 by that date.

Fauna accounts created after August 21, 2024 must use FQL v10. These accounts will not be able to run FQL v4 queries or access the v4 Dashboard.

For more details, see the v4 EOL announcement and migration guide. Contact support@fauna.com with any questions.

IsDoc

This reference topic applies to FQL v4. Go to this page for the latest FQL v10 reference topics.

 
IsDoc( value )
is_doc( value )
IsDoc( value )
IsDoc( value )
IsDoc( value )
IsDoc( value )

Description

The IsDoc function returns true only if value is a document, otherwise it returns false.

Parameters

Parameter Type Definition and Requirements

value

Any

Any value, which is to be tested to determine whether it is a document or not.

Returns

Returns a Boolean, indicating whether value was a document or not.

Examples

The following query uses Map to iterate over an array of all of the types of values that can be tested by a type-check function, passing each item into a Lambda function that returns an object, which contains the value and the result of calling IsDoc with that value:

client.query(
  q.Map(
    [
      ['array'],
      true,
      false,
      new Uint8Array([1, 2, 3, 4]),
      [0x1, 0x2, 0x3, 0x4],
      q.Collection('Letters'),
      q.Ref('credentials/self'),
      q.Database('child_db'),
      q.Date('2019-11-12'),
      q.Ref(q.Collection('Letters'), 123),
      10.1,
      q.Function('double'),
      q.Index('letters'),
      10,
      q.Ref(q.Keys(), '1'),
      q.Query(q.Lambda('x', q.Var('x'))),
      null,
      { x: 10 },
      q.Role('employees'),
      q.Match(q.Index('letters')),
      'ten',
      '10',
      q.Time('2020-07-06T12:34:56.789Z'),
      q.Ref(q.Tokens(), '1'),
    ],
    q.Lambda('x', {
      value: q.Var('x'),
      IsDoc: q.IsDoc(q.Var('x')),
    })
  )
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
[
  { value: [ 'array' ], IsDoc: false },
  { value: true, IsDoc: false },
  { value: false, IsDoc: false },
  { value: Bytes("AQIDBA=="), IsDoc: false },
  { value: [ 1, 2, 3, 4 ], IsDoc: false },
  { value: Collection("Letters"), IsDoc: true },
  { value: Ref(Credentials(), "268432282800357888"), IsDoc: true },
  { value: Database("child_db"), IsDoc: true },
  { value: Date("2019-11-12"), IsDoc: false },
  { value: Ref(Collection("Letters"), "123"), IsDoc: true },
  { value: 10.1, IsDoc: false },
  { value: Function("double"), IsDoc: true },
  { value: Index("letters"), IsDoc: true },
  { value: 10, IsDoc: false },
  { value: Ref(Keys(), "1"), IsDoc: true },
  { value: Query(Lambda("x", Var("x"))), IsDoc: false },
  { value: null, IsDoc: false },
  { value: { x: 10 }, IsDoc: false },
  { value: Role("employees"), IsDoc: true },
  { value: Match(Index("letters")), IsDoc: false },
  { value: 'ten', IsDoc: false },
  { value: '10', IsDoc: false },
  { value: Time("2020-06-15T21:17:04.941Z"), IsDoc: false },
  { value: Ref(Tokens(), "1"), IsDoc: true }
]
result = client.query(
  q.map_(
    q.lambda_("x", {
      "value": q.var("x"),
      "IsDoc": q.is_doc(q.var("x")),
    }),
    [
      ["array"],
      True,
      False,
      bytearray([1, 2, 3, 4]),
      [0x1, 0x2, 0x3, 0x4],
      q.collection("Letters"),
      q.ref("credentials/self"),
      q.database("child_db"),
      q.date("2019-11-12"),
      q.ref(q.collection("Letters"), 123),
      10.1,
      q.function("double"),
      q.index("letters"),
      10,
      q.ref(q.keys(), "1"),
      q.query(q.lambda_("x", q.var("x"))),
      None,
      {"x": 10},
      q.role("employees"),
      q.match(q.index("letters")),
      "ten",
      "10",
      q.time("2020-07-06T12:34:56.789Z"),
      q.ref(q.tokens(), "1"),
    ],
  )
)
print(result)
[{'value': ['array'], 'IsDoc': False}, {'value': True, 'IsDoc': False}, {'value': False, 'IsDoc': False}, {'value': bytearray(b'\x01\x02\x03\x04'), 'IsDoc': False}, {'value': [1, 2, 3, 4], 'IsDoc': False}, {'value': Ref(id=Letters, collection=Ref(id=collections)), 'IsDoc': True}, {'value': Ref(id=282032258185953792, collection=Ref(id=credentials)), 'IsDoc': True}, {'value': Ref(id=child_db, collection=Ref(id=databases)), 'IsDoc': True}, {'value': datetime.date(2019, 11, 12), 'IsDoc': False}, {'value': Ref(id=123, collection=Ref(id=Letters, collection=Ref(id=collections))), 'IsDoc': True}, {'value': 10.1, 'IsDoc': False}, {'value': Ref(id=double, collection=Ref(id=functions)), 'IsDoc': True}, {'value': Ref(id=letters, collection=Ref(id=indexes)), 'IsDoc': True}, {'value': 10, 'IsDoc': False}, {'value': Ref(id=1, collection=Ref(id=keys)), 'IsDoc': True}, {'value': Query({'api_version': '4', 'lambda': 'x', 'expr': {'var': 'x'}}), 'IsDoc': False}, {'value': None, 'IsDoc': False}, {'value': {'x': 10}, 'IsDoc': False}, {'value': Ref(id=employees, collection=Ref(id=roles)), 'IsDoc': True}, {'value': SetRef({'match': Ref(id=letters, collection=Ref(id=indexes))}), 'IsDoc': False}, {'value': 'ten', 'IsDoc': False}, {'value': '10', 'IsDoc': False}, {'value': FaunaTime('2020-07-06T12:34:56.789Z'), 'IsDoc': False}, {'value': Ref(id=1, collection=Ref(id=tokens)), 'IsDoc': True}]
result, err := client.Query(
	f.Map(
		f.Arr{
			f.Arr{"array"},
			true,
			false,
			f.BytesV{0x01, 0x02, 0x03, 0x04},
			f.Arr{0x1, 0x2, 0x3, 0x4},
			f.Collection("Letters"),
			f.Ref("credentials/self"),
			f.Database("child_db"),
			f.Date("2019-11-12"),
			f.Ref(f.Collection("Letters"), 123),
			10.1,
			f.Function("double"),
			f.Index("letters"),
			10,
			f.Ref(f.Keys(), "1"),
			f.Query(f.Lambda("x", f.Var("x"))),
			nil,
			f.Null(),
			f.Obj{"x": 10},
			f.Role("employees"),
			f.Match(f.Index("letters")),
			"ten",
			"10",
			f.Time("2020-07-06T12:34:56.789Z"),
			f.Ref(f.Tokens(), "1"),
		},
		f.Lambda("x", f.Obj{
			"value": f.Var("x"),
			"IsDoc": f.IsDoc(f.Var("x")),
		})))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
[map[IsDoc:false value:[array]] map[IsDoc:false value:true] map[IsDoc:false value:false] map[IsDoc:false value:[1 2 3 4]] map[IsDoc:false value:[1 2 3 4]] map[IsDoc:true value:{Letters 0xc0000c5e30 0xc0000c5e30 <nil>}] map[IsDoc:true value:{280481857410171392 0xc0000c5f50 0xc0000c5f50 <nil>}] map[IsDoc:true value:{child_db 0xc000164090 0xc000164090 <nil>}] map[IsDoc:false value:{0 63709113600 <nil>}] map[IsDoc:true value:{123 0xc00009a180 0xc00009a180 <nil>}] map[IsDoc:false value:10.1] map[IsDoc:true value:{double 0xc00009a2d0 0xc00009a2d0 <nil>}] map[IsDoc:true value:{letters 0xc00009a3f0 0xc00009a3f0 <nil>}] map[IsDoc:false value:10] map[IsDoc:true value:{1 0xc00009a540 0xc00009a540 <nil>}] map[IsDoc:false value:{[123 34 97 112 105 95 118 101 114 115 105 111 110 34 58 34 51 34 44 34 108 97 109 98 100 97 34 58 34 120 34 44 34 101 120 112 114 34 58 123 34 118 97 114 34 58 34 120 34 125 125]}] map[IsDoc:false value:{}] map[IsDoc:false value:{}] map[IsDoc:false value:map[x:10]] map[IsDoc:true value:{employees 0xc00009a750 0xc00009a750 <nil>}] map[IsDoc:false value:{map[match:{letters 0xc00009a8a0 0xc00009a8a0 <nil>}]}] map[IsDoc:false value:ten] map[IsDoc:false value:10] map[IsDoc:false value:{789000000 63729635696 <nil>}] map[IsDoc:true value:{1 0xc00009aa50 0xc00009aa50 <nil>}]]
try
{
    Value result = await client.Query(
        Map(
            Arr(
                Arr("array"),
                true,
                false,
                BytesV.Of(0x1, 0x2, 0x3, 0x4),
                Arr(0x1, 0x2, 0x3, 0x4),
                Collection("Letters"),
                Ref("credentials/self"),
                Database("child_db"),
                Date("2019-11-12"),
                Ref(Collection("Letters"), 123),
                10.1,
                Function("double"),
                Index("letters"),
                10,
                Ref(Keys(), "1"),
                Query(Lambda("x", Var("x"))),
                null,
                Obj("x", 10),
                Role("employees"),
                Match(Index("letters")),
                "ten",
                "10",
                Time("2020-07-06T12:34:56.789Z"),
                Ref(Tokens(), "1")
            ),
            Lambda(
                "x",
                Obj(
                    "value", Var("x"),
                    "IsDoc", IsDoc(Var("x"))
                )
            )
        )
    );

    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
Arr(ObjectV(value: Arr(StringV(array)),IsDoc: BooleanV(False)), ObjectV(value: BooleanV(True),IsDoc: BooleanV(False)), ObjectV(value: BooleanV(False),IsDoc: BooleanV(False)), ObjectV(value: BytesV(0x01, 0x02, 0x03, 0x04),IsDoc: BooleanV(False)), ObjectV(value: Arr(LongV(1), LongV(2), LongV(3), LongV(4)),IsDoc: BooleanV(False)), ObjectV(value: RefV(id = "Letters", collection = RefV(id = "collections")),IsDoc: BooleanV(True)), ObjectV(value: RefV(id = "295433208677270016", collection = RefV(id = "credentials")),IsDoc: BooleanV(True)), ObjectV(value: RefV(id = "child_db", collection = RefV(id = "databases")),IsDoc: BooleanV(True)), ObjectV(value: FaunaDate(2019-11-12 12:00:00 AM),IsDoc: BooleanV(False)), ObjectV(value: RefV(id = "123", collection = RefV(id = "Letters", collection = RefV(id = "collections"))),IsDoc: BooleanV(True)), ObjectV(value: DoubleV(10.1),IsDoc: BooleanV(False)), ObjectV(value: RefV(id = "double", collection = RefV(id = "functions")),IsDoc: BooleanV(True)), ObjectV(value: RefV(id = "letters", collection = RefV(id = "indexes")),IsDoc: BooleanV(True)), ObjectV(value: LongV(10),IsDoc: BooleanV(False)), ObjectV(value: RefV(id = "1", collection = RefV(id = "keys")),IsDoc: BooleanV(True)), ObjectV(value: QueryV(System.Collections.Generic.Dictionary`2[System.String,FaunaDB.Query.Expr]),IsDoc: BooleanV(False)), ObjectV(value: NullV,IsDoc: BooleanV(False)), ObjectV(value: ObjectV(x: LongV(10)),IsDoc: BooleanV(False)), ObjectV(value: RefV(id = "employees", collection = RefV(id = "roles")),IsDoc: BooleanV(True)), ObjectV(value: SetRefV(System.Collections.Generic.Dictionary`2[System.String,FaunaDB.Types.Value]),IsDoc: BooleanV(False)), ObjectV(value: StringV(ten),IsDoc: BooleanV(False)), ObjectV(value: StringV(10),IsDoc: BooleanV(False)), ObjectV(value: FaunaTime(2020-07-06T12:34:56.789Z),IsDoc: BooleanV(False)), ObjectV(value: RefV(id = "1", collection = RefV(id = "tokens")),IsDoc: BooleanV(True)))
System.out.println(
    client.query(
        Map(
            Arr(
                Arr(Value("array")),
                Value(true),
                Value(false),
                Value(new byte[] {0x1, 0x2, 0x3, 0x4}),
                Arr(Value(0x1), Value(0x2), Value(0x3), Value(0x4)),
                Collection("Letters"),
                Ref("credentials/self"),
                Database("child_db"),
                Date("2019-11-12"),
                Ref(Collection("Letters"), "123"),
                Value(10.1),
                Function("double"),
                Index("letters"),
                Value(10),
                Ref(Keys(), "1"),
                Query(Lambda("x", Var("x"))),
                Null(),
                Obj("x", Value(10)),
                Role("employees"),
                Match(Index("letters")),
                Value("ten"),
                Value("10"),
                Time("2020-07-06T12:34:56.789Z"),
                Ref(Tokens(), "1")
            ),
            Lambda(
                "x",
                Obj("value", Var("x"), "IsDoc", IsDoc(Var("x")))
            )
        )
    ).get());
[{value: ["array"], IsDoc: false}, {value: true, IsDoc: false}, {value: false, IsDoc: false}, {value: [0x01 0x02 0x03 0x04], IsDoc: false}, {value: [1, 2, 3, 4], IsDoc: false}, {value: ref(id = "Letters", collection = ref(id = "collections")), IsDoc: true}, {value: ref(id = "286816445084467712", collection = ref(id = "credentials")), IsDoc: true}, {value: ref(id = "child_db", collection = ref(id = "databases")), IsDoc: true}, {value: 2019-11-12, IsDoc: false}, {value: ref(id = "123", collection = ref(id = "Letters", collection = ref(id = "collections"))), IsDoc: true}, {value: 10.1, IsDoc: false}, {value: ref(id = "double", collection = ref(id = "functions")), IsDoc: true}, {value: ref(id = "letters", collection = ref(id = "indexes")), IsDoc: true}, {value: 10, IsDoc: false}, {value: ref(id = "1", collection = ref(id = "keys")), IsDoc: true}, {value: QueryV({api_version=4, lambda=x, expr={var=x}}), IsDoc: false}, {value: null, IsDoc: false}, {value: {x: 10}, IsDoc: false}, {value: ref(id = "employees", collection = ref(id = "roles")), IsDoc: true}, {value: {@set = {match: ref(id = "letters", collection = ref(id = "indexes"))}}, IsDoc: false}, {value: "ten", IsDoc: false}, {value: "10", IsDoc: false}, {value: 2020-07-06T12:34:56.789Z, IsDoc: false}, {value: ref(id = "1", collection = ref(id = "tokens")), IsDoc: true}]
Map(
  [
    ['array'],
    true,
    false,
    new Uint8Array([1, 2, 3, 4]),
    [0x1, 0x2, 0x3, 0x4],
    Collection('Letters'),
    Ref('credentials/self'),
    Database('child_db'),
    Date('2019-11-12'),
    Ref(Collection('Letters'), 123),
    10.1,
    Function('double'),
    Index('letters'),
    10,
    Ref(Keys(), '1'),
    Query(Lambda('x', Var('x'))),
    null,
    { x: 10 },
    Role('employees'),
    Match(Index('letters')),
    'ten',
    '10',
    Time('2020-07-06T12:34:56.789Z'),
    Ref(Tokens(), '1'),
  ],
  Lambda('x', {
    value: Var('x'),
    IsDoc: IsDoc(Var('x')),
  })
)
[
  { value: [ 'array' ], IsDoc: false },
  { value: true, IsDoc: false },
  { value: false, IsDoc: false },
  { value: { '0': 1, '1': 2, '2': 3, '3': 4 }, IsDoc: false },
  { value: [ 1, 2, 3, 4 ], IsDoc: false },
  { value: Collection("Letters"), IsDoc: true },
  { value: Ref(Credentials(), "302043979982045696"), IsDoc: true },
  { value: Database("child_db"), IsDoc: true },
  { value: Date("2019-11-12"), IsDoc: false },
  { value: Ref(Collection("Letters"), "123"), IsDoc: true },
  { value: 10.1, IsDoc: false },
  { value: Function("double"), IsDoc: true },
  { value: Index("letters"), IsDoc: true },
  { value: 10, IsDoc: false },
  { value: Ref(Keys(), "1"), IsDoc: true },
  { value: Query(Lambda("x", Var("x"))), IsDoc: false },
  { value: null, IsDoc: false },
  { value: { x: 10 }, IsDoc: false },
  { value: Role("employees"), IsDoc: true },
  { value: Match(Index("letters")), IsDoc: false },
  { value: 'ten', IsDoc: false },
  { value: '10', IsDoc: false },
  { value: Time("2020-07-06T12:34:56.789Z"), IsDoc: false },
  { value: Ref(Tokens(), "1"), IsDoc: true }
]
Query metrics:

  •    bytesIn:   594

  •   bytesOut: 1,503

  • computeOps:     2

  •    readOps:     0

  •   writeOps:     0

  •  readBytes:   373

  • writeBytes:     0

  •  queryTime:  26ms

  •    retries:     0

This query operates on a pre-existing schema, which is not provided here.

Also, the query is executed via a client connection, that uses a secret acquired by calling the Login function (not shown here), so that Ref("credentials/self") returns a valid value.

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!