flatbuffers/docs/source/Compiler.md

Using the schema compiler

Usage:

flatc [ GENERATOR OPTIONS ] [ -o PATH ] [ -I PATH ] FILES...
      [ -- FILES...]

The files are read and parsed in order, and can contain either schemas or data (see below). Data files are processed according to the definitions of the most recent schema specified.

-- indicates that the following files are binary files in FlatBuffer format conforming to the schema indicated before it.

Depending on the flags passed, additional files may be generated for each file processed:

For any schema input files, one or more generators can be specified:

• --cpp, -c : Generate a C++ header for all definitions in this file (as filename_generated.h).

• --java, -j : Generate Java code.

• --kotlin, -k : Generate Kotlin code.

• --csharp, -n : Generate C# code.

• --go, -g : Generate Go code.

• --python, -p: Generate Python code.

• --js, -s: Generate JavaScript code.

• --ts: Generate TypeScript code.

• --php: Generate PHP code.

• --grpc: Generate RPC stub code for GRPC.

• --dart: Generate Dart code.

• --lua: Generate Lua code.

• --lobster: Generate Lobster code.

• --rust, -r : Generate Rust code.

For any data input files:

• --binary, -b : If data is contained in this file, generate a filename.bin containing the binary flatbuffer (or a different extension if one is specified in the schema).

• --json, -t : If data is contained in this file, generate a filename.json representing the data in the flatbuffer.

Additional options:

• -o PATH : Output all generated files to PATH (either absolute, or relative to the current directory). If omitted, PATH will be the current directory. PATH should end in your systems path separator, e.g. / or \.

• -I PATH : when encountering include statements, attempt to load the files from this path. Paths will be tried in the order given, and if all fail (or none are specified) it will try to load relative to the path of the schema file being parsed.

• -M : Print make rules for generated files.

• --strict-json : Require & generate strict JSON (field names are enclosed in quotes, no trailing commas in tables/vectors). By default, no quotes are required/generated, and trailing commas are allowed.

• --allow-non-utf8 : Pass non-UTF-8 input through parser and emit nonstandard \x escapes in JSON. (Default is to raise parse error on non-UTF-8 input.)

• --natural-utf8 : Output strings with UTF-8 as human-readable strings. By default, UTF-8 characters are printed as \uXXXX escapes."

• --defaults-json : Output fields whose value is equal to the default value when writing JSON text.

• --no-prefix : Don't prefix enum values in generated C++ by their enum type.

• --scoped-enums : Use C++11 style scoped and strongly typed enums in generated C++. This also implies --no-prefix.

• --gen-includes : (deprecated), this is the default behavior. If the original behavior is required (no include statements) use --no-includes.

• --no-includes : Don't generate include statements for included schemas the generated file depends on (C++ / Python).

• --gen-mutable : Generate additional non-const accessors for mutating FlatBuffers in-place.

• --gen-onefile : Generate single output file for C# and Go.

• --gen-name-strings : Generate type name functions for C++.

• --gen-object-api : Generate an additional object-based API. This API is more convenient for object construction and mutation than the base API, at the cost of efficiency (object allocation). Recommended only to be used if other options are insufficient.

• --gen-compare : Generate operator== for object-based API types.

• --gen-nullable : Add Clang _Nullable for C++ pointer. or @Nullable for Java.

• --gen-generated : Add @Generated annotation for Java.

• --gen-all : Generate not just code for the current schema files, but for all files it includes as well. If the language uses a single file for output (by default the case for C++ and JS), all code will end up in this one file.

• --cpp-include : Adds an #include in generated file

• --cpp-ptr-type T : Set object API pointer type (default std::unique_ptr)

• --cpp-str-type T : Set object API string type (default std::string) T::c_str(), T::length() and T::empty() must be supported. The custom type also needs to be constructible from std::string (see the --cpp-str-flex-ctor option to change this behavior).

• --cpp-str-flex-ctor : Don't construct custom string types by passing std::string from Flatbuffers, but (char* + length). This allows efficient construction of custom string types, including zero-copy construction.

• --object-prefix : Customise class prefix for C++ object-based API.

• --object-suffix : Customise class suffix for C++ object-based API.

• --no-js-exports : Removes Node.js style export lines (useful for JS)

• --goog-js-export : Uses goog.exportsSymbol and goog.exportsProperty instead of Node.js style exporting. Needed for compatibility with the Google closure compiler (useful for JS).

• --es6-js-export : Generates ECMAScript v6 style export definitions instead of Node.js style exporting. Useful when integrating flatbuffers with modern Javascript projects.

• --go-namespace : Generate the overrided namespace in Golang.

• --go-import : Generate the overrided import for flatbuffers in Golang. (default is "github.com/google/flatbuffers/go").

• --raw-binary : Allow binaries without a file_indentifier to be read. This may crash flatc given a mismatched schema.

• --size-prefixed : Input binaries are size prefixed buffers.

• --proto: Expect input files to be .proto files (protocol buffers). Output the corresponding .fbs file. Currently supports: package, message, enum, nested declarations, import (use -I for paths), extend, oneof, group. Does not support, but will skip without error: option, service, extensions, and most everything else.

• --oneof-union : Translate .proto oneofs to flatbuffer unions.

• --grpc : Generate GRPC interfaces for the specified languages.

• --schema: Serialize schemas instead of JSON (use with -b). This will output a binary version of the specified schema that itself corresponds to the reflection/reflection.fbs schema. Loading this binary file is the basis for reflection functionality.

• --bfbs-comments: Add doc comments to the binary schema files.

• --conform FILE : Specify a schema the following schemas should be an evolution of. Gives errors if not. Useful to check if schema modifications don't break schema evolution rules.

• --conform-includes PATH : Include path for the schema given with --conform PATH.

• --include-prefix PATH : Prefix this path to any generated include statements.

• --keep-prefix : Keep original prefix of schema include statement.

• --no-fb-impor : Don't include flatbuffers import statement for TypeScript.

• --no-ts-reexpor : Don't re-export imported dependencies for TypeScript.

• --short-name : Use short function names for JS and TypeScript.

• --reflect-types : Add minimal type reflection to code generation.

• --reflect-names : Add minimal type/name reflection.

• --root-type T : Select or override the default root_type.

• --force-defaults : Emit default values in binary output from JSON.

• --force-empty : When serializing from object API representation, force strings and vectors to empty rather than null.

NOTE: short-form options for generators are deprecated, use the long form whenever possible.