Component object method · N/query

joinFrom()

Component.joinFrom(options)

Creates an explicit directional join relationship from another component to this component (an inverse join).

Implementation
Not started
Design
Open for proposals suggest how it should read
Proposals
A
Signature
Component.joinFrom(options)
Module
N/query
Returns
query.Component
Governance
None
Script types
Client and server scripts
Version
SuiteScript 2.x, documented for 2.1; since NetSuite 2018.2
call shapefrom Oracle's parameter table
1objComponent.joinFrom({2    fieldId: /* string, required */,3    source:  /* string, required */4});
Oracle reference for this method
ParameterTypeRequiredDescription
options.fieldIdstringrequiredThe column type (field type) that joins the parent component to the new component. Obtain this value from the Records Catalog. The Records Catalog lists every record type and field that is available using SuiteAnalytics Workbook and the N/query module. For more information, see Records Catalog Overview .
options.sourcestringrequiredThe query type of the component joined to this component. This value sets the Component.source property. This value can be described as the inverse relationship of this component, and it determines the source query type of the newly joined component.
B

No Mynt syntax yet.

Nothing in the language compiles to Component.joinFrom(options) today. How should it read?

C

Competing syntax for joinFrom, from GitHub Discussions. Select two or more to compare them side by side.

All discussions

Loading proposals from GitHub…

D

Write the Mynt you wish you could write.

A good proposal shows the syntax, the SuiteScript it should become, and argues for it: why it is clearer, how it fits the rest of the language, what it makes harder.

  • Clarity. Does it say what happens, without ceremony?
  • Consistency. Does it read like load, save and Ref[field]?
  • Expressiveness. Does it cover the cases people actually write?
  • Honesty. Does it hide a NetSuite cost, such as governance, that a reader should see?

N/query · Component.joinFrom(options)

Suggest syntax for joinFrom