IsCredentials

Not available in this language yet.
IsCredentials( value )
IsCredentials( value )
IsCredentials( value )
Not available in this language yet.
IsCredentials( value )

Description

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

Parameters

Argument Type Definition and Requirements

value

Any

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

Returns

Returns a boolean, indicating whether value was a credentials 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 IsCredentials 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"),
      "IsCredentials": f.IsCredentials(f.Var("x")),
    })))

if (err != nil) {
  fmt.Println(err)
} else {
  fmt.Println(result)
}
[map[IsCredentials:false value:[array]] map[IsCredentials:false value:true] map[IsCredentials:false value:false] map[IsCredentials:false value:[1 2 3 4]] map[IsCredentials:false value:[1 2 3 4]] map[IsCredentials:false value:{Letters 0xc00008f380 0xc00008f380 <nil>}] map[IsCredentials:true value:{264354436692836874 0xc00008f4d0 0xc00008f4d0 <nil>}] map[IsCredentials:false value:{child_db 0xc00008f5f0 0xc00008f5f0 <nil>}] map[IsCredentials:false value:{0 63709113600 <nil>}] map[IsCredentials:false value:{123 0xc00008f830 0xc00008f830 <nil>}] map[IsCredentials:false value:10.1] map[IsCredentials:false value:{double 0xc00008fa10 0xc00008fa10 <nil>}] map[IsCredentials:false value:{all_letters 0xc00008fb30 0xc00008fb30 <nil>}] map[IsCredentials:false value:10] map[IsCredentials:false value:{248967241620521472 0xc00008fc80 0xc00008fc80 <nil>}] map[IsCredentials: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[IsCredentials:false value:{}] map[IsCredentials:false value:{}] map[IsCredentials:false value:map[x:10]] map[IsCredentials:false value:{employees 0xc00008fe90 0xc00008fe90 <nil>}] map[IsCredentials:false value:{map[match:{all_letters 0xc000448000 0xc000448000 <nil>}]}] map[IsCredentials:false value:ten] map[IsCredentials:false value:10] map[IsCredentials:false value:{299907000 63724302198 <nil>}] map[IsCredentials:false value:{249062079147803136 0xc0004481b0 0xc0004481b0 <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"), "IsCredentials", IsCredentials(Var("x")))
            )
        )
    ).get());
[{value: ["array"], IsCredentials: false},
 {value: true, IsCredentials: false},
 {value: false, IsCredentials: false},
 {value: [0x01 0x02 0x03 0x04], IsCredentials: false},
 {value: [1, 2, 3, 4], IsCredentials: false},
 {value: ref(id = "Letters", collection = ref(id = "collections")),
  IsCredentials: false},
 {value: ref(id = "248967019900174848", collection = ref(id = "credentials")),
  IsCredentials: true},
 {value: ref(id = "child_db", collection = ref(id = "databases")),
  IsCredentials: false},
 {value: 2019-11-12, IsCredentials: false},
 {value: ref(id = "123", collection = ref(id = "Letters", collection = ref(id = "collections"))),
  IsCredentials: false},
 {value: 10.1, IsCredentials: false},
 {value: ref(id = "double", collection = ref(id = "functions")),
  IsCredentials: false},
 {value: ref(id = "all_letters", collection = ref(id = "indexes")),
  IsCredentials: false},
 {value: 10, IsCredentials: false},
 {value: ref(id = "248967241620521472", collection = ref(id = "keys")),
  IsCredentials: false},
 {value: QueryV({lambda=x, expr={var=x}}), IsCredentials: false},
 {value: null, IsCredentials: false},
 {value: {x: 10}, IsCredentials: false},
 {value: ref(id = "employees", collection = ref(id = "roles")),
  IsCredentials: false},
 {value: {@set = {match: ref(id = "all_letters", collection = ref(id = "indexes"))}},
  IsCredentials: false},
 {value: "ten", IsCredentials: false},
 {value: "10", IsCredentials: false},
 {value: 2019-11-12T13:15:16.789Z, IsCredentials: false},
 {value: ref(id = "249062079147803136", collection = ref(id = "tokens")),
  IsCredentials: false}]
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'),
      IsCredentials: q.IsCredentials(q.Var('x')),
    })
  )
)
.then((ret) => console.log(ret))
[ { value: [ 'array' ], IsCredentials: false },
  { value: true, IsCredentials: false },
  { value: false, IsCredentials: false },
  { value: Bytes("AQIDBA=="), IsCredentials: false },
  { value: [ 1, 2, 3, 4 ], IsCredentials: false },
  { value: Collection("Letters"), IsCredentials: false },
  { value: Ref(Credentials(), "248967019900174848"),
    IsCredentials: true },
  { value: Database("child_db"), IsCredentials: false },
  { value: Date("2019-11-12"), IsCredentials: false },
  { value: Ref(Collection("Letters"), "123"),
    IsCredentials: false },
  { value: 10.1, IsCredentials: false },
  { value: Function("double"), IsCredentials: false },
  { value: Index("all_letters"), IsCredentials: false },
  { value: 10, IsCredentials: false },
  { value: Ref(Keys(), "248967241620521472"),
    IsCredentials: false },
  { value: Query(Lambda("x", Var("x"))), IsCredentials: false },
  { value: null, IsCredentials: false },
  { value: { x: 10 }, IsCredentials: false },
  { value: Role("employees"), IsCredentials: false },
  { value: Match(Index("all_letters")), IsCredentials: false },
  { value: 'ten', IsCredentials: false },
  { value: '10', IsCredentials: false },
  { value: Time("2019-11-12T13:15:16.789Z"),
    IsCredentials: false },
  { value: Ref(Tokens(), "249062079147803136"),
    IsCredentials: false } ]
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"), "IsCredentials" -> IsCredentials(Var("x")))
      )
    )
  ),
  5.seconds
))
[{value: ["array"], IsCredentials: false},
 {value: true, IsCredentials: false},
 {value: false, IsCredentials: false},
 {value: [0x01 0x02 0x03 0x04], IsCredentials: false},
 {value: [1, 2, 3, 4], IsCredentials: false},
 {value: ref(id = "Letters", collection = ref(id = "collections")),
  IsCredentials: false},
 {value: ref(id = "248967019900174848", collection = ref(id = "credentials")), IsCredentials: true},
 {value: ref(id = "child_db", collection = ref(id = "databases")),
  IsCredentials: false},
 {value: 2019-11-12, IsCredentials: false},
 {value: ref(id = "123", collection = ref(id = "Letters", collection = ref(id = "collections"))),
  IsCredentials: false},
 {value: 10.1, IsCredentials: false},
 {value: ref(id = "double", collection = ref(id = "functions")),
  IsCredentials: false},
 {value: ref(id = "all_letters", collection = ref(id = "indexes")),
  IsCredentials: false},
 {value: 10, IsCredentials: false},
 {value: ref(id = "248967241620521472", collection = ref(id = "keys")),
  IsCredentials: false},
 {value: {lambda: "x", expr: {var: "x"}}, IsCredentials: false},
 {value: NullV, IsCredentials: false},
 {value: {x: 10}, IsCredentials: false},
 {value: ref(id = "employees", collection = ref(id = "roles")),
  IsCredentials: false},
 {value: {@set = {match: ref(id = "all_letters", collection = ref(id = "indexes"))}},
  IsCredentials: false},
 {value: "ten", IsCredentials: false},
 {value: "10", IsCredentials: false},
 {value: 2019-11-12T13:15:16.789Z, IsCredentials: false},
 {value: ref(id = "249062079147803136", collection = ref(id = "tokens")),
  IsCredentials: false}]

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 Login (not shown here), so that Ref("credentials/self") returns a valid value.

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve!
Visit Fauna's Discourse forums or email docs@fauna.com

Thank you for your feedback!