docs/modules/ROOT/pages/reference/extensions/flatpack.adoc

// Do not edit directly!
// This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page
= Flatpack
:linkattrs:
:cq-artifact-id: camel-quarkus-flatpack
:cq-native-supported: true
:cq-status: Stable
:cq-status-deprecation: Stable
:cq-description: Parse fixed width and delimited files using the FlatPack library.
:cq-deprecated: false
:cq-jvm-since: 1.1.0
:cq-native-since: 1.1.0

[.badges]
[.badge-key]##JVM since##[.badge-supported]##1.1.0## [.badge-key]##Native since##[.badge-supported]##1.1.0##

Parse fixed width and delimited files using the FlatPack library.

== What's inside

* xref:{cq-camel-components}::flatpack-component.adoc[Flatpack component], URI syntax: `flatpack:type:resourceUri`
* xref:{cq-camel-components}:dataformats:flatpack-dataformat.adoc[Flatpack data format]

Please refer to the above links for usage and configuration details.

== Maven coordinates

https://code.quarkus.io/?extension-search=camel-quarkus-flatpack[Create a new project with this extension on code.quarkus.io, window="_blank"]

Or add the coordinates to your existing project:

[source,xml]
----
<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-flatpack</artifactId>
</dependency>
----

Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.

== Additional Camel Quarkus configuration

This component typically loads Flatpack mappings from classpath.
To make it work also in native mode, you need to explicitly embed the mappings in the native executable
by using the `quarkus.native.resources.includes` property.

For instance, the route below loads the Flatpack mappings from a classpath resource named `mappings/simple.pzmap.xml`:

[source,java]
----
from("direct:start").to("flatpack:delim:mappings/simple.pzmap.xml");
----

To include this (an possibly other mappings stored in `.pzmap.xml` files under the `mappings` directory) in the native image, you would have to add something like the following to your `application.properties` file:

[source,properties]
----
quarkus.native.resources.includes = mappings/*.pzmap.xml
----

More information about selecting resources for inclusion in the native executable can be found at xref:user-guide/native-mode.adoc#embedding-resource-in-native-executable[Embedding resource in native executable].