Skip to content

Commit c2017c3

Browse files
AndreiKingsleyAndreiKingsley
committed
update migration guide
1 parent 86a17a4 commit c2017c3

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

‎docs/StardustDocs/topics/MigrationTo_1_0.md‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ All related methods are now located in the separate [`dataframe-csv`](Modules.md
1515
(which is included by default in the general [`dataframe`](Modules.md#dataframe-general) artifact
1616
and in `%use dataframe` in [Kotlin Notebook](SetupKotlinNotebook.md)).
1717

18-
Functions were also renamed to the correct CamelCase spelling.
18+
Functions were also renamed to the correct [CamelCase](https://en.wikipedia.org/wiki/Camel_case) spelling.
1919

2020
All new functions keep the same arguments as before and additionally introduce new ones.
2121
Also, [there are new arguments that expose Deephaven CSV features](read.md#unlocking-deephaven-csv-features).
@@ -49,6 +49,21 @@ one for the new stdlib `kotlin.time.Instant` and one for the old deprecated `kot
4949
The behavior of old operations remains unchanged: they work with `kotlinx.datetime.Instant` and raise `ERROR` in 1.0.
5050
In version 1.1, they will be returned and will operate on the new stdlib `kotlin.time.Instant`.
5151

52+
In version 1.0, all parsing operations still convert `Instant`
53+
values into the deprecated `kotlinx.datetime.Instant`.
54+
To enable parsing into the new standard library `kotlin.time.Instant`,
55+
set the corresponding parsing option **`ParserOptions.parseExperimentalInstant`**
56+
(that will be default in 1.1).
57+
For example:
58+
59+
```kotlin
60+
DataFrame.readCsv(
61+
...,
62+
parserOptions = ParserOptions(parseExperimentalInstant = true)
63+
)
64+
```
65+
66+
5267
<table>
5368
<tr>
5469
<th>0.15</th>
@@ -113,11 +128,11 @@ The next functions and classes raise `ERROR` in 1.0 and will be removed in 1.1.
113128

114129
| 0.15 | 1.0 | Reason |
115130
|----------------------------------------------------------------|------------------------------------------------------------------------------|----------------------------------------|
116-
| `DataColumn.createFrameColumn(name, df, startIndices)` | `df.chunked(name, startIndices)` | Replaced with an other function. |
117-
| `DataColumn.createWithTypeInference(name, values, nullable)` | `DataColumn.createByInference(name, values, TypeSuggestion.Infer, nullable)` | Replaced with an other function. |
118-
| `DataColumn.create(name, values, infer)` | `DataColumn.createByType(name, values, infer)` | Replaced with an other function. |
131+
| `DataColumn.createFrameColumn(name, df, startIndices)` | `df.chunked(name, startIndices)` | Replaced with another function. |
132+
| `DataColumn.createWithTypeInference(name, values, nullable)` | `DataColumn.createByInference(name, values, TypeSuggestion.Infer, nullable)` | Replaced with another function. |
133+
| `DataColumn.create(name, values, infer)` | `DataColumn.createByType(name, values, infer)` | Replaced with another function. |
119134
| `col.isComparable()` | `col.valuesAreComparable()` | Renamed to better reflect its purpose. |
120-
| `df.minus { columns }` | `df.remove { columns }` | Replaced with an other function. |
135+
| `df.minus { columns }` | `df.remove { columns }` | Replaced with another function. |
121136
| `df.move { columns }.toLeft()`/`df.moveToLeft{ columns }` | `df.move { columns }.toStart()`/`df.moveToStart { columns }` | Renamed to better reflect its purpose. |
122137
| `df.move { columns }.toRight()`/`df.moveToRight{ columns }` | `df.move { columns }.toEnd()`/`df.moveToEnd{ columns }` | Renamed to better reflect its purpose. |
123138
| `row.rowMin()`/`row.rowMinOrNull()` | `row.rowMinOf()`/`row.rowMinOfOrNull()` | Renamed to better reflect its purpose. |
@@ -129,10 +144,10 @@ The next functions and classes raise `ERROR` in 1.0 and will be removed in 1.1.
129144
| `df.writeHTML()` | `df.writeHtml()` | Renamed to the correct CamelCase. |
130145
| `asURL(fileOrUrl)`/`isURL(path)` | `asUrl(fileOrUrl)`/`isUrl(path)` | Renamed to the correct CamelCase. |
131146
| `df.convert { columns }.toURL()`/`df.convertToURL { columns }` | `df.convert { columns }.toUrl()`/`df.convertToUrl { columns }` | Renamed to the correct CamelCase. |
132-
| `df.filterBy(column)` | `df.filter { column }` | Replaced with an other function. |
147+
| `df.filterBy(column)` | `df.filter { column }` | Replaced with another function. |
133148
| `FormattingDSL` | `FormattingDsl` | Renamed to the correct CamelCase. |
134149
| `RGBColor` | `RgbColor` | Renamed to the correct CamelCase. |
135-
| `df.insert(column).after(columnPath)` | `df.insert(column).after { columnPath }` | Replaced with an other function. |
150+
| `df.insert(column).after(columnPath)` | `df.insert(column).after { columnPath }` | Replaced with another function. |
136151
| `CompareResult.Equals` / `CompareResult.isEqual()` | `CompareResult.Matches` / `CompareResult.matches()` | Renamed to better reflect its purpose. |
137152
| `CompareResult.isSuperOrEqual()` | `CompareResult.isSuperOrMatches()` | Renamed to better reflect its purpose. |
138153

@@ -141,8 +156,8 @@ The next functions and classes raise `WARNING` in 1.0 and `ERROR` in 1.1.
141156
| 0.15 | 1.0 | Reason |
142157
|----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|
143158
| `df.split { columns }.default(..)` / `df.split { columns }.into(..)` / `df.split { columns }.inward(..)` | `df.split { columns }.by(..).default(..)` / `df.split { columns }.by(..).into(..)` / `df.split { columns }.by(..).inward(..)` | Removed a shortcut to clarify the behaviour; Only for `String` columns. |
144-
| `dataFrameOf(header, values)` | `dataFrameOf(header).withValues(values)` | Replaced with an other function. |
145-
| `df.generateCode(..)` | `df.generateInterfaces(..)` | Replaced with an other function. |
159+
| `dataFrameOf(header, values)` | `dataFrameOf(header).withValues(values)` | Replaced with another function. |
160+
| `df.generateCode(..)` | `df.generateInterfaces(..)` | Replaced with another function. |
146161
| `df.select { mapToColumn(name, infer) { body } }` | `df.select { expr(name, infer) { body } }` | Removed duplicated functionality. |
147162
| `stringCol.length()` | `stringCol.map { it?.length ?: 0 }` | Removed a shortcut to clarify the behaviour; Only for `String` columns. |
148163
| `stringCol.lowercase()` / `stringCol.uppercase()` | `stringCol.map { it?.lowercase() }` / `stringCol.map { it?.uppercase() }` | Removed a shortcut to clarify the behaviour; Only for `String` columns. |

0 commit comments

Comments
 (0)