IsCredentials

IsCredentials( value )
IsCredentials( value )
is_credentials( value )
IsCredentials( value )

Description

The IsCredentials function returns true only if value is a credentials 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 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:

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"),
			"IsCredentials": f.IsCredentials(f.Var("x")),
		})))

if err != nil {
	fmt.Fprintln(os.Stderr, 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 0xc00008e3c0 0xc00008e3c0 <nil>}] map[IsCredentials:true value:{280481857410171392 0xc00008e4e0 0xc00008e4e0 <nil>}] map[IsCredentials:false value:{child_db 0xc00018a030 0xc00018a030 <nil>}] map[IsCredentials:false value:{0 63709113600 <nil>}] map[IsCredentials:false value:{123 0xc00018a240 0xc00018a240 <nil>}] map[IsCredentials:false value:10.1] map[IsCredentials:false value:{double 0xc00018a390 0xc00018a390 <nil>}] map[IsCredentials:false value:{letters 0xc00018a4b0 0xc00018a4b0 <nil>}] map[IsCredentials:false value:10] map[IsCredentials:false value:{1 0xc00018a600 0xc00018a600 <nil>}] map[IsCredentials: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[IsCredentials:false value:{}] map[IsCredentials:false value:{}] map[IsCredentials:false value:map[x:10]] map[IsCredentials:false value:{employees 0xc00018a810 0xc00018a810 <nil>}] map[IsCredentials:false value:{map[match:{letters 0xc00018a960 0xc00018a960 <nil>}]}] map[IsCredentials:false value:ten] map[IsCredentials:false value:10] map[IsCredentials:false value:{789000000 63729635696 <nil>}] map[IsCredentials:false value:{1 0xc00018ab10 0xc00018ab10 <nil>}]]
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'),
      IsCredentials: q.IsCredentials(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' ], 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(), "268432021103052288"),
    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("letters"), IsCredentials: false },
  { value: 10, IsCredentials: false },
  { value: Ref(Keys(), "1"), 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("letters")), IsCredentials: false },
  { value: 'ten', IsCredentials: false },
  { value: '10', IsCredentials: false },
  { value: Time("2020-06-15T21:12:55.442Z"), IsCredentials: false },
  { value: Ref(Tokens(), "1"), IsCredentials: false }
]
result = client.query(
  q.map_(
    q.lambda_("x", {
      "value": q.var("x"),
      "IsCredentials": q.is_credentials(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'], 'IsCredentials': False}, {'value': True, 'IsCredentials': False}, {'value': False, 'IsCredentials': False}, {'value': bytearray(b'\x01\x02\x03\x04'), 'IsCredentials': False}, {'value': [1, 2, 3, 4], 'IsCredentials': False}, {'value': Ref(id=Letters, collection=Ref(id=collections)), 'IsCredentials': False}, {'value': Ref(id=282032258185953792, collection=Ref(id=credentials)), 'IsCredentials': True}, {'value': Ref(id=child_db, collection=Ref(id=databases)), 'IsCredentials': False}, {'value': datetime.date(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=letters, collection=Ref(id=indexes)), 'IsCredentials': False}, {'value': 10, 'IsCredentials': False}, {'value': Ref(id=1, collection=Ref(id=keys)), 'IsCredentials': False}, {'value': Query({'api_version': '4', 'lambda': 'x', 'expr': {'var': 'x'}}), 'IsCredentials': False}, {'value': None, 'IsCredentials': False}, {'value': {'x': 10}, 'IsCredentials': False}, {'value': Ref(id=employees, collection=Ref(id=roles)), 'IsCredentials': False}, {'value': SetRef({'match': Ref(id=letters, collection=Ref(id=indexes))}), 'IsCredentials': False}, {'value': 'ten', 'IsCredentials': False}, {'value': '10', 'IsCredentials': False}, {'value': FaunaTime('2020-07-06T12:34:56.789Z'), 'IsCredentials': False}, {'value': Ref(id=1, collection=Ref(id=tokens)), 'IsCredentials': False}]
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'),
    IsCredentials: IsCredentials(Var('x')),
  })
)
[
  { value: [ 'array' ], IsCredentials: false },
  { value: true, IsCredentials: false },
  { value: false, IsCredentials: false },
  { value: { '0': 1, '1': 2, '2': 3, '3': 4 }, IsCredentials: false },
  { value: [ 1, 2, 3, 4 ], IsCredentials: false },
  { value: Collection("Letters"), IsCredentials: false },
  {
    value: Ref(Credentials(), "302043979982045696"),
    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("letters"), IsCredentials: false },
  { value: 10, IsCredentials: false },
  { value: Ref(Keys(), "1"), 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("letters")), IsCredentials: false },
  { value: 'ten', IsCredentials: false },
  { value: '10', IsCredentials: false },
  { value: Time("2020-07-06T12:34:56.789Z"), IsCredentials: false },
  { value: Ref(Tokens(), "1"), IsCredentials: false }
]
Query metrics:

  •    bytesIn:   610

  •   bytesOut: 1,703

  • computeOps:     2

  •    readOps:     0

  •   writeOps:     0

  •  readBytes:   373

  • writeBytes:     0

  •  queryTime:  25ms

  •    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!