IsDoc
Not available in this language yet.IsDoc( value )IsDoc( value )IsDoc( value )Not available in this language yet.IsDoc( value )Description
The IsDoc function returns true only if value is a document,
otherwise it returns false.
Parameters
| Argument | Type | Definition and Requirements |
|---|---|---|
|
Any |
Any value, which is to be tested to determine whether it is 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:
Not available in this language yet.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.RefCollection(f.Collection("Letters"), 123),
10.1,
f.Function("double"),
f.Index("all_letters"),
10,
f.RefCollection(f.Keys(), "248967241620521472"),
f.Query(f.Lambda("x", f.Var("x"))),
nil,
f.Null(),
f.Obj{ "x": 10 },
f.Role("employees"),
f.Match(f.Index("all_letters")),
"ten",
"10",
f.Now(),
f.RefCollection(f.Tokens(), "249062079147803136"),
},
f.Lambda("x", f.Obj{
"value": f.Var("x"),
"IsDoc": f.IsDoc(f.Var("x")),
})))
if (err != nil) {
fmt.Println(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 0xc00008e450 0xc00008e450 <nil>}] map[IsDoc:true value:{264354436692836874 0xc00008e570 0xc00008e570 <nil>}] map[IsDoc:true value:{child_db 0xc00008e690 0xc00008e690 <nil>}] map[IsDoc:false value:{0 63709113600 <nil>}] map[IsDoc:true value:{123 0xc00008e8a0 0xc00008e8a0 <nil>}] map[IsDoc:false value:10.1] map[IsDoc:true value:{double 0xc00008e9f0 0xc00008e9f0 <nil>}] map[IsDoc:true value:{all_letters 0xc00008eb10 0xc00008eb10 <nil>}] map[IsDoc:false value:10] map[IsDoc:true value:{248967241620521472 0xc00008ec60 0xc00008ec60 <nil>}] map[IsDoc:false value:{[123 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:false value:{employees 0xc00008ee70 0xc00008ee70 <nil>}] map[IsDoc:false value:{map[match:{all_letters 0xc00008efc0 0xc00008efc0 <nil>}]}] map[IsDoc:false value:ten] map[IsDoc:false value:10] map[IsDoc:false value:{565075000 63724302284 <nil>}] map[IsDoc:true value:{249062079147803136 0xc00008f170 0xc00008f170 <nil>}]]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("all_letters"),
Value(10),
Ref(Keys(), "248967241620521472"),
Query(Lambda("x", Var("x"))),
Null(),
Obj("x", Value(10)),
Role("employees"),
Match(Index("all_letters")),
Value("ten"),
Value("10"),
Now(),
Ref(Tokens(), "249062079147803136")
),
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 = "248967019900174848", 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 = "all_letters", collection = ref(id = "indexes")),
IsDoc: true},
{value: 10, IsDoc: false},
{value: ref(id = "248967241620521472", collection = ref(id = "keys")),
IsDoc: true},
{value: QueryV({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 = "all_letters", collection = ref(id = "indexes"))}},
IsDoc: false},
{value: "ten", IsDoc: false},
{value: "10", IsDoc: false},
{value: 2019-11-12T13:15:16.789Z, IsDoc: false},
{value: ref(id = "249062079147803136", collection = ref(id = "tokens")),
IsDoc: true}]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('all_letters'),
10,
q.Ref(q.Keys(), '248967241620521472'),
q.Query(q.Lambda('x', q.Var('x'))),
null,
{ x: 10 },
q.Role('employees'),
q.Match(q.Index('all_letters')),
'ten',
'10',
q.Now(),
q.Ref(q.Tokens(), '249062079147803136'),
],
q.Lambda('x', {
value: q.Var('x'),
IsDoc: q.IsDoc(q.Var('x')),
})
)
)
.then((ret) => console.log(ret))[ { 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(), "248967019900174848"), 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("all_letters"), IsDoc: true },
{ value: 10, IsDoc: false },
{ value: Ref(Keys(), "248967241620521472"), 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("all_letters")), IsDoc: false },
{ value: 'ten', IsDoc: false },
{ value: '10', IsDoc: false },
{ value: Time("2019-11-12T13:15:16.789Z"), IsDoc: false },
{ value: Ref(Tokens(), "249062079147803136"), IsDoc: true } ]Not available in this language yet.println(Await.result(
client.query(
Map(
Arr(
Arr("array"),
true,
false,
BytesV(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("all_letters"),
10,
Ref(Keys(), "248967241620521472"),
Query(Lambda("x", Var("x"))),
Null,
Obj("x" -> 10),
Role("employees"),
Match(Index("all_letters")),
"ten",
"10",
Now(),
Ref(Tokens(), "249062079147803136")
),
Lambda(
"x",
Obj( "value" -> Var("x"), "IsDoc" -> IsDoc(Var("x")))
)
)
),
5.seconds
))[{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 = "248967019900174848", 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 = "all_letters", collection = ref(id = "indexes")),
IsDoc: true},
{value: 10, IsDoc: false},
{value: ref(id = "248967241620521472", collection = ref(id = "keys")),
IsDoc: true},
{value: {lambda: "x", expr: {var: "x"}}, IsDoc: false},
{value: NullV, IsDoc: false},
{value: {x: 10}, IsDoc: false},
{value: ref(id = "employees", collection = ref(id = "roles")),
IsDoc: true},
{value: {@set = {match: ref(id = "all_letters", collection = ref(id = "indexes"))}},
IsDoc: false},
{value: "ten", IsDoc: false},
{value: "10", IsDoc: false},
{value: 2019-11-12T13:15:16.789Z, IsDoc: false},
{value: ref(id = "249062079147803136", collection = ref(id = "tokens")),
IsDoc: true}]|
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
|
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!