updated flux data model doc, updated IMPL callouts

pull/91/head
Scott Anderson 2019-03-14 07:19:02 -05:00
parent 782ed4f55f
commit 81690509b7
7 changed files with 37 additions and 17 deletions

View File

@ -33,7 +33,7 @@ The package name does not appear in any scope.
Its purpose is to identify the files belonging to the same package and to specify the default package name for import declarations.
{{% note %}}
To be implemented: [IMPL#247](https://github.com/influxdata/platform/issues/247) Add package/namespace support.
[IMPL#247](https://github.com/influxdata/platform/issues/247) Add package/namespace support.
{{% /note %}}
## Variable assignment

View File

@ -30,7 +30,7 @@ Saturday = 6
```
{{% note %}}
To be implemented: [IMPL#153](https://github.com/influxdata/flux/issues/153) Add Days of the Week constants
[IMPL#153](https://github.com/influxdata/flux/issues/153) Add Days of the Week constants
{{% /note %}}
## Months of the year
@ -52,5 +52,5 @@ December = 12
```
{{% note %}}
To be implemented: [IMPL#154](https://github.com/influxdata/flux/issues/154) Add Months of the Year constants
[IMPL#154](https://github.com/influxdata/flux/issues/154) Add Months of the Year constants
{{% /note %}}

View File

@ -45,16 +45,36 @@ These common values are referred to as the "group key value" and can be represen
A tables schema consists of its group key and its columns' labels and types.
{{% note %}}
[IMPL#463](https://github.com/influxdata/flux/issues/463) Specify the primitive types that make up stream and table types
{{% /note %}}
## Stream of tables
A **stream** represents a potentially unbounded set of tables.
A stream is grouped into individual tables using their respective group keys.
Tables within a stream each have a unique group key value.
{{% note %}}
[IMPL#463](https://github.com/influxdata/flux/issues/463) Specify the primitive types that make up stream and table types
{{% /note %}}
## Missing values
A record may be missing a value for a specific column.
Missing values are represented with a special `null` value.
The `null` value can be of any data type.
{{% note %}}
To be implemented: [IMPL#300](https://github.com/influxdata/platform/issues/300) Design how nulls behave
[IMPL#723](https://github.com/influxdata/platform/issues/723) Design how nulls behave
{{% /note %}}
## Transformations
Transformations define a change to a stream.
Transformations may consume an input stream and always produce a new output stream.
The output stream group keys have a stable output order based on the input stream.
Specific ordering may change between releases, but is not considered a breaking change.
Most transformations output one table for every table they receive from the input stream.
Transformations that modify group keys or values regroup the tables in the output stream.
A transformation produces side effects when constructed from a function that produces side effects.
Transformations are represented using function types.

View File

@ -65,7 +65,7 @@ empty in or package builtin
```
{{% note %}}
To be implemented: [IMPL#256](https://github.com/influxdata/platform/issues/256) Add in and empty operator support.
[IMPL#256](https://github.com/influxdata/platform/issues/256) Add in and empty operator support.
{{% /note %}}
@ -93,7 +93,7 @@ The following coercion rules apply to numeric literals:
* An error will occur if the coerced type cannot represent the literal value.
{{% note %}}
To be implemented: [IMPL#255](https://github.com/influxdata/platform/issues/255) Allow numeric literal coercion.
[IMPL#255](https://github.com/influxdata/platform/issues/255) Allow numeric literal coercion.
{{% /note %}}
### Integer literals
@ -138,7 +138,7 @@ decimals = decimal_digit { decimal_digit } .
```
{{% note %}}
To be implemented: [IMPL#254](https://github.com/influxdata/platform/issues/254) Parse float literals.
[IMPL#254](https://github.com/influxdata/platform/issues/254) Parse float literals.
{{% /note %}}
### Duration literals
@ -217,7 +217,7 @@ When months are added to a date times and the resulting date is past the end of
```
{{% note %}}
To be implemented: [IMPL#657](https://github.com/influxdata/platform/issues/657) Implement Duration vectors.
[IMPL#657](https://github.com/influxdata/platform/issues/657) Implement Duration vectors.
{{% /note %}}
## Date and time literals
@ -254,7 +254,7 @@ time_offset = "Z" | ("+" | "-" ) hour ":" minute .
```
{{% note %}}
To be implemented: [IMPL#152](https://github.com/influxdata/flux/issues/152) Implement shorthand time literals.
[IMPL#152](https://github.com/influxdata/flux/issues/152) Implement shorthand time literals.
{{% /note %}}
### String literals
@ -287,7 +287,7 @@ StringExpression = "{" Expression "}" .
{{% note %}}
To be added: TODO: With string interpolation `string_lit` is not longer a lexical token as part of a literal, but an entire expression in and of itself.
To be implemented: [IMPL#252](https://github.com/influxdata/platform/issues/252) Parse string literals.
[IMPL#252](https://github.com/influxdata/platform/issues/252) Parse string literals.
{{% /note %}}
##### Examples of string literals
@ -309,7 +309,7 @@ A function `printf` exists to allow more precise control over formatting of vari
To include the literal curly brackets within a string they must be escaped.
{{% note %}}
To be implemented: [IMPL#248](https://github.com/influxdata/platform/issues/248) Add printf function.
[IMPL#248](https://github.com/influxdata/platform/issues/248) Add printf function.
{{% /note %}}
##### Example: Interpolation
@ -323,7 +323,7 @@ n = 42
```
{{% note %}}
To be implemented: [IMPL#251](https://github.com/influxdata/platform/issues/251) Add string interpolation support
[IMPL#251](https://github.com/influxdata/platform/issues/251) Add string interpolation support
{{% /note %}}
### Regular expression literals

View File

@ -58,5 +58,5 @@ option location = loadLocation(name:"America/Denver") // Set location to be Amer
```
{{% note %}}
To be implemented: [IMPL#660](https://github.com/influxdata/platform/issues/660) Implement Location option
[IMPL#660](https://github.com/influxdata/platform/issues/660) Implement Location option
{{% /note %}}

View File

@ -42,7 +42,7 @@ When a file does not declare a package clause, all identifiers in that
file will belong to the special `main` package.
{{% note %}}
To be implemented: [IMPL#247](https://github.com/influxdata/platform/issues/247) Add package/namespace support.
[IMPL#247](https://github.com/influxdata/platform/issues/247) Add package/namespace support.
{{% /note %}}
### Package main

View File

@ -19,7 +19,7 @@ Types are never explicitly declared as part of the syntax.
Types are always inferred from the usage of the value.
{{% note %}}
To be implemented: [IMPL#249](https://github.com/influxdata/platform/issues/249) Specify type inference rules.
[IMPL#249](https://github.com/influxdata/platform/issues/249) Specify type inference rules.
{{% /note %}}
## Boolean types
@ -89,7 +89,7 @@ The value may be any other type, and need not be the same as other values within
A _function type_ represents a set of all functions with the same argument and result types.
{{% note %}}
To be implemented: [IMPL#249](https://github.com/influxdata/platform/issues/249) Specify type inference rules.
[IMPL#249](https://github.com/influxdata/platform/issues/249) Specify type inference rules.
{{% /note %}}
## Generator types
@ -98,5 +98,5 @@ A _generator type_ represents a value that produces an unknown number of other v
The generated values may be of any other type, but must all be the same type.
{{% note %}}
To be implemented: [IMPL#658](https://github.com/influxdata/platform/query/issues/658) Implement Generators types.
[IMPL#658](https://github.com/influxdata/platform/query/issues/658) Implement Generators types.
{{% /note %}}