| //// |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| //// |
| :imagesdir: ../../assets/images/ |
| :page-pagination: |
| :description: A Beam File Definition describes a file layout in a Beam pipeline. The Beam File Definition specifies the file layout (name, field definitions, enclosure and separator) to be used in Beam Pipelines. |
| |
| = Beam File Definition |
| |
| == Description |
| |
| image:icons/folder.svg[] |
| |
| A Beam File Definition describes a file layout in a Beam pipeline and specifies the file layout (name, field definitions, enclosure and separator) to be used in Beam Pipelines. |
| |
| == Related Plugins |
| |
| Transforms: |
| |
| * xref:pipeline/transforms/beaminput.adoc[Beam Input] |
| * xref:pipeline/transforms/beamoutput.adoc[Beam Output] |
| |
| == Options |
| |
| [options="header"] |
| |=== |
| |Option |Description |
| |Name|The name to be used for this Beam file definition |
| |Description|The description to be used for this Beam file definition |
| |Field Separator|separator used between fields in the file definition |
| |Enclosure|field enclosure used for fields in the file definition |
| |Field Definitions|List of field name, type, format, length and precision. |
| Describes the file layout for this field definition. |
| |=== |
| |
| == Samples |
| |
| * beam/pipelines/complex.hpl |
| * beam/pipelines/generate-synthetic-data.hpl |
| * beam/pipelines/input-process-output.hpl |
| * beam/pipelines/switch-case.hpl |
| * beam/pipelines/unbounded-synthetic-data.hpl |
