Skip to content

YIELD Syntax

Keyword YIELD can be used as a clause in a FETCH or GO statement, or as a separate statement in PIPE(|), or as a stand-alone statement for calculation.

As Clause (With GO-Syntax)

YIELD
    [DISTINCT]
    <col_name> [AS <col_alias>]
    [, <col_name> [AS <col_alias>] ...]

YIELD is commonly used to return results generated with GO (Refer GO).

nebula> GO FROM 100 OVER follow YIELD $$.player.name AS Friend, $$.player.age AS Age;
===========================
| Friend            | Age |
===========================
| Tony Parker       | 36  |
---------------------------
| LaMarcus Aldridge | 33  |
---------------------------
| Kyle Anderson     | 25  |
---------------------------

For example: $$.player.name is used to get the property of the destination vertex ($$).

As Statement

Reference Inputs or Variables

  • You can use the YIELD statement in PIPE.
  • You can use the YIELD statement to reference variables.
  • For statements that do not support YIELD statement, you can use it as a tool to control the output.
YIELD
    [DISTINCT]
    <col_name> [AS <col_alias>]
    [, <col_name> [AS <col_alias>] ...]
    [WHERE <conditions>]

nebula> GO FROM 100 OVER follow YIELD follow._dst AS id | YIELD $-.* WHERE $-.id == 106;

=========
| $-.id |
=========
| 106   |
---------

nebula> $var1 = GO FROM 101 OVER follow; $var2 = GO FROM 105 OVER follow; YIELD $var1.* UNION YIELD DISTINCT $var2.*;

=====================
| $var1.follow._dst |
=====================
| 100               |
---------------------
| 102               |
---------------------
| 104               |
---------------------
| 116               |
---------------------
| 125               |
---------------------

nebula> GO 2 STEPS FROM 100 OVER follow YIELD follow._dst AS dst | YIELD DISTINCT $-.dst AS dst

=======
| dst |
=======
| 100 |
-------
| 102 |
-------
| 125 |
-------

As Stand-alone Statement

YIELD statement can be used independently to retrieve computation results without reference to any graph. You can use AS to rename it an alias.

nebula> YIELD 1 + 1;
=========
| (1+1) |
=========
| 2     |
---------

nebula> YIELD "Hel" + "\tlo" AS HELLO_1, ", World!" AS WORLD_2;
======================
| HELLO_1 | WORLD_2  |
======================
| Hel  lo  | , World! |
----------------------

nebula> YIELD hash("Tim") % 100;
=====================
| (hash("Tim")%100) |
=====================
| 42                |
---------------------
Last update: April 16, 2021