UltipaDocs
Products
Solutions
Resources
Company
Start Free Trial
UltipaDocs
Start Free Trial
  • Introduction
    • Overview
    • Node and Edge Patterns
    • Path Patterns
    • Quantified Paths
    • Shortest Paths
    • Graph Patterns
    • Overview
    • Typed Graph
    • Open Graph
    • Graph Sharding and Storage
    • Constraints
    • Unique Identifiers
    • INSERT
    • INSERT OVERWRITE
    • UPSERT
    • SET
    • REMOVE
    • DELETE
    • Query Composition
    • Result Table and Visualization
    • MATCH
    • OPTIONAL MATCH
    • FILTER
    • LET
    • FOR
    • ORDER BY
    • LIMIT
    • SKIP
    • CALL
    • RETURN
    • Composite Query
    • NEXT
    • All Functions
    • Scalar Functions
    • Path Functions
    • Aggregate Functions
    • Mathematical Functions
    • Trigonometric Functions
    • String Functions
    • List Functions
    • Datetime Functions
    • Spatial Functions
    • Label Functions
    • Record Functions
    • Table Functions
  • Operators
  • Predicates
    • CASE
    • NULLIF
    • COALESCE
    • LET Value Expression
    • Value Query Expression
    • Index
    • Full-text Index
    • Vector Index
    • Spatial Index
    • Overview
    • Managing HDC Graphs
    • HDC Graph Queries
  • Transaction
  • Trigger
  • Stored Procedure
    • Process
    • Session
    • Job
    • Execution Plan
    • Variables
    • Values and Types
    • Comments
    • Reserved Words
    • Syntactic Notation
  • Access Control
  • GQL Conformance
  1. Docs
  2. /
  3. ISO GQL
  4. /
  5. Functions

Record Functions

keys()

Returns a list of all field names in a record.

Syntaxkeys(<record>)
ArgumentsNameTypeDescription
<record>RECORDThe input record
Return TypeLIST
GQL
RETURN keys({name: 'Alice', age: 30})

Result:

keys({name: 'Alice', age: 30})
["name","age"]

recordContains()

Returns true if the record contains the specified field.

SyntaxrecordContains(<record>, <key>)
ArgumentsNameTypeDescription
<record>RECORDThe input record
<key>STRINGThe field name to check
Return TypeBOOL
GQL
RETURN recordContains({name: 'Alice', age: 30}, 'name')

Result:

recordContains({name: 'Alice', age: 30}, 'name')
true

recordGet()

Returns the value of the specified field in a record.

SyntaxrecordGet(<record>, <key>)
ArgumentsNameTypeDescription
<record>RECORDThe input record
<key>STRINGThe field name to retrieve
Return TypeType of the field value
GQL
RETURN recordGet({name: 'Alice', age: 30}, 'name')

Result:

recordGet({name: 'Alice', age: 30}, 'name')
Alice

recordRemove()

Returns a new record with the specified field removed.

SyntaxrecordRemove(<record>, <key>)
ArgumentsNameTypeDescription
<record>RECORDThe input record
<key>STRINGThe field name to remove
Return TypeRECORD
GQL
RETURN recordRemove({name: 'Alice', age: 30}, 'age')

Result:

recordRemove({name: 'Alice', age: 30}, 'age')
{name: "Alice"}

recordSet()

Returns a new record with the specified field set to the given value.

SyntaxrecordSet(<record>, <key>, <value>)
ArgumentsNameTypeDescription
<record>RECORDThe input record
<key>STRINGThe field name to set
<value>AnyThe value to assign to the field
Return TypeRECORD
GQL
RETURN recordSet({name: 'Alice'}, 'age', 30)

Result:

recordSet({name: 'Alice'}, 'age', 30)
{name: "Alice", age: 30}