Skip to content

Commit 0b0e7dc

Browse files
committed
Add comment for TableParameterSpecification
1 parent 5faf4c8 commit 0b0e7dc

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/relational/table/specification/TableParameterSpecification.java

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,24 @@
2121

2222
import java.util.Optional;
2323

24+
/**
25+
* TableParameterSpecification are classified by two characteristics:
26+
*
27+
* <ul>
28+
* <li>1. Input tables have either row semantics or set semantics, as follows:
29+
* <ul>
30+
* <li>Row semantics means that the the result of the PTF as decided on a row-by-row basis.
31+
* As an extreme example, the DBMS could atomize the input table into individual rows,
32+
* and send each single row to a different processor.
33+
* <li>Set semantics means that the outcome of the function depends on how the data is
34+
* partitioned. A partition shall not be split across processors, nor may a processor
35+
* handle more than one partition.
36+
* </ul>
37+
* <li>2. Whether the input table supports pass-through columns or not. Pass-through columns isa
38+
* mechanism enabling the PTF to copy every column of an input row into columns of an output
39+
* row.
40+
* </ul>
41+
*/
2442
public class TableParameterSpecification extends ParameterSpecification {
2543
// set semantics or row semantics (default is set semantics)
2644
private final boolean rowSemantics;

0 commit comments

Comments
 (0)