Annotation Interface N1qlJoin
This annotation is targeted for entity field which is a list of the associated entities fetched by ANSI Join across
the entities available from Couchbase Server 5.5
- Author:
- Subhashni Balakrishnan
-
Required Element Summary
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionFetch type specifies how the associated entities are fetchedFetchType
Hash side specification for the associated entity for hash join Note: Supported on enterprise edition onlyHint index for entity for indexed nested loop joinString[]
Use keys query hintHint index for associated entity for indexed nested loop joinWhere clause for the join.
-
Element Details
-
on
String onJoin Criteria can be a simple equi join or multiple conditions combined using AND or OR. Array based equi joins with unnest is also possible. To reference fields in entity use prefix "lks." (left key space) and for referencing fields in associated entities use "rks." (right key space)
-
-
-
fetchType
FetchType fetchTypeFetch type specifies how the associated entities are fetchedFetchType
- Default:
- IMMEDIATE
-
where
String whereWhere clause for the join. To reference fields in entity use prefix "lks." and for referencing fields in associated entities use "rks."- Default:
- ""
-
index
String indexHint index for entity for indexed nested loop join- Default:
- ""
-
rightIndex
String rightIndexHint index for associated entity for indexed nested loop join- Default:
- ""
-
hashside
HashSide hashsideHash side specification for the associated entity for hash join Note: Supported on enterprise edition only- Default:
- NONE
-
keys
String[] keysUse keys query hint- Default:
- {}
-