mynt

module function · N/dataset

createJoin()

dataset.createJoin(options)

Creates a dataset join.

Implementation
Not started
Design
Open for proposals suggest how it should read
Proposals
A suitescript api
Signature
dataset.createJoin(options)
Module
N/dataset
Returns
dataset.Join
Governance
None
Script types
Server scripts
Version
SuiteScript 2.x, documented for 2.1; since NetSuite 2020.2
call shapefrom Oracle's parameter table
1dataset.createJoin({2    fieldId: /* string, required */,3    join:    /* dataset.Join, optional */,4    source:  /* string, optional */,5    target:  /* string, optional */6});
Oracle reference for this method
ParameterTypeRequiredDescription
options.fieldIdstringrequiredThe ID of the record field for the join. When you perform a join, you must specify the field to be used to perform the join. For example, consider a transaction record. Transaction records can be joined to customer records using the entity field on the transaction record. If you joined a transaction record to a customer record in this way, the value of this property is 'entity'.
options.joindataset.JoinoptionalThe existing join used to a create multi-level join. Use this parameter only if a child join exists with the current join as its parent.
options.sourcestringoptionalThe internal ID for the source record type for the join used to create an inverse join. Use the Records Catalog to find the Internal ID of scriptable records.
options.targetstringoptionalThe polymorphic target of the join.
B mynt syntax

No Mynt syntax yet.

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

C community proposals

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

All discussions

Loading proposals from GitHub…

D suggest an alternative

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/dataset · dataset.createJoin(options)

Suggest syntax for createJoin