Skip to content

Commit b680b87

Browse files
authored
Documentation update for fixedlength2 (#172)
Documentation update for `fixedlength2`
1 parent 3b9fcb5 commit b680b87

File tree

6 files changed

+510
-26
lines changed

6 files changed

+510
-26
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,19 @@ writing. Learn the concept and tricks in depth.
2424
- [Use of `custom_func`, Specially `javascript`](./doc/use_of_custom_funcs.md): An in depth look of how `custom_func`
2525
is used, specially the all mighty `javascript` (and `javascript_with_context`).
2626
- [CSV Schema in Depth](./doc/csv_in_depth.md): everything about schemas for CSV input.
27-
- [Fixed-Length Schema in Depth](./doc/fixedlength_in_depth.md): everything about schemas for fixed-length (e.g. TXT)
27+
- [Fixed-Length Schema in Depth](./doc/fixedlength2_in_depth.md): everything about schemas for fixed-length (e.g. TXT)
2828
input
2929
- [JSON/XML Schema in Depth](./doc/json_xml_in_depth.md): everything about schemas for JSON or XML input.
3030
- [EDI Schema in Depth](./doc/edi_in_depth.md): everything about schemas for EDI input.
3131
- [Programmability](./doc/programmability.md): Advanced techniques for using omniparser (or some of its components) in
3232
your code.
3333

3434
References:
35-
- [Custom Functions](./doc/customfuncs.md): a complete reference of all built-in custom functions.
35+
- [Custom Functions](./doc/customfuncs.md): a complete reference of all built-in custom functions.
3636

3737
Examples:
3838
- [CSV Examples](extensions/omniv21/samples/csv)
39-
- [Fixed-Length Examples](extensions/omniv21/samples/fixedlength)
39+
- [Fixed-Length Examples](extensions/omniv21/samples/fixedlength2)
4040
- [JSON Examples](extensions/omniv21/samples/json)
4141
- [XML Examples](extensions/omniv21/samples/xml).
4242
- [EDI Examples](extensions/omniv21/samples/edi).
@@ -67,6 +67,7 @@ situations.
6767
- Golang 1.14 or later.
6868

6969
## Recent Major Feature Additions/Changes
70+
- 2022/8: Added `fixedlength2` file format that supersedes the original `fixed-length` format with support of hierarchical and nested envelopes.
7071
- 1.0.0 Released!
7172
- Added `Transform.RawRecord()` for caller of omniparser to access the raw ingested record.
7273
- Deprecated `custom_parse` in favor of `custom_func` (`custom_parse` is still usable for
@@ -78,16 +79,16 @@ back-compatibility, it is just removed from all public docs and samples).
7879
- Upgrade omni schema version to `omni.2.1` due a number of incompatible schema changes:
7980
- `'result_type'` -> `'type'`
8081
- `'ignore_error_and_return_empty_str` -> `'ignore_error'`
81-
- `'keep_leading_trailing_space'` -> `'no_trim'`
82+
- `'keep_leading_trailing_space'` -> `'no_trim'`
8283
- Changed how we handle custom functions: previously we always use strings as in param type as well as result param
8384
type. Not anymore, all types are supported for custom function in and out params.
8485
- Changed the way how we package custom functions for extensions: previously we collect custom functions from all
8586
extensions and then pass all of them to the extension that is used; This feels weird, now changed to only the custom
8687
functions included in a particular extension are used in that extension.
87-
- Deprecated/removed most of the custom functions in favor of using 'javascript'.
88+
- Deprecated/removed most of the custom functions in favor of using 'javascript'.
8889
- A number of package renaming.
8990
- Added CSV file format support in omniv2 handler.
90-
- Introduced IDR node cache for allocation recycling.
91+
- Introduced IDR node cache for allocation recycling.
9192
- Introduced [IDR](./doc/idr.md) for in-memory data representation.
9293
- Added trie based high performance `times.SmartParse`.
9394
- Command line interface (one-off `transform` cmd or long-running http `server` mode).

cli/cmd/serverCmd.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ func httpPostTransform(w http.ResponseWriter, r *http.Request) {
154154

155155
var (
156156
sampleDir = "../../extensions/omniv21/samples/"
157-
sampleFormats = []string{"csv", "json", "xml", "fixedlength", "fixedlength2", "edi"}
157+
sampleFormats = []string{"csv", "json", "xml", "fixedlength2", "edi"}
158158
sampleInputFilenamePattern = regexp.MustCompile("^([0-9]+[_a-zA-Z0-9]+)\\.input\\.[a-z]+$")
159159
)
160160

0 commit comments

Comments
 (0)