Apache Thrift

https://thrift.apache.org/docs/
Admin
Apache Thrift is a software framework for cross-language services development that enables seamless...
Tokens:11,270
Snippets:192
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Build and Install Thrift Compiler (Cygwin/MinGW)

Source: https://thrift.apache.org/docs/install/windows.html

After configuring, navigate to the compiler directory and run 'make' to build the Thrift compiler and optionally runtime libraries. 'make install' installs the compiled components.

```bash
cd compiler/cpp
make
make install

```

--------------------------------

### Install Thrift

Source: https://thrift.apache.org/docs/BuildingFromSource

After a successful build, run 'make install' from the top-level source directory as superuser to install the compiled Thrift components on your system.

```bash
make install
```

--------------------------------

### Install Node.js and npm

Source: https://thrift.apache.org/docs/install/debian.html

Installs Node.js and npm, required for Node.js development with Apache Thrift.

```bash
nodejs npm

```

--------------------------------

### Install Boost Library on OS X

Source: https://thrift.apache.org/docs/install/os_x.html

Compile and install the Boost library from source. Ensure you download the library from boost.org.

```bash
./bootstrap.sh
sudo ./b2 threading=multi address-model=64 variant=release stage install

```

--------------------------------

### Download and Install Autoconf 2.69

Source: https://thrift.apache.org/docs/install/centos.html

Downloads, compiles, and installs Autoconf version 2.69, a prerequisite for building Apache Thrift.

```bash
wget http://ftp.gnu.org/gnu/autoconf/autoconf-2.69.tar.gz
tar xvf autoconf-2.69.tar.gz
cd autoconf-2.69
./configure --prefix=/usr
make
sudo make install
cd ..

```

--------------------------------

### Download and Install Automake 1.14

Source: https://thrift.apache.org/docs/install/centos.html

Downloads, compiles, and installs Automake version 1.14, a prerequisite for building Apache Thrift.

```bash
wget http://ftp.gnu.org/gnu/automake/automake-1.14.tar.gz
tar xvf automake-1.14.tar.gz
cd automake-1.14
./configure --prefix=/usr
make
sudo make install
cd ..

```

--------------------------------

### Install .NET Core SDK and Runtime

Source: https://thrift.apache.org/docs/install/debian.html

Installs the .NET Core SDK and ASP.NET Core runtime for .NET development with Apache Thrift on Linux/Ubuntu.

```bash
apt-transport-https dotnet-sdk-6.0 aspnetcore-runtime-6.0

```

--------------------------------

### Install D Language Compiler (DMD)

Source: https://thrift.apache.org/docs/install/debian.html

Installs the D programming language compiler (DMD) using the official installation script.

```bash
curl -fsS https://dlang.org/install.sh | bash -s dmd

```

--------------------------------

### Manual Install of Automake and Boost for Older Debian/Ubuntu

Source: https://thrift.apache.org/docs/install/debian.html

For Debian 7/Ubuntu 12 users, manually install a newer version of automake and boost. This involves downloading, unpacking, and installing the packages.

```bash
wget http://ftp.debian.org/debian/pool/main/a/automake-1.15/automake_1.15-3_all.deb
sudo dpkg -i automake_1.15-3_all.deb

wget http://sourceforge.net/projects/boost/files/boost/1.60.0/boost_1_60_0.tar.gz
tar xvf boost_1_60_0.tar.gz
cd boost_1_60_0
./bootstrap.sh
sudo ./b2 install

```

--------------------------------

### Configure Thrift Build - Specify Boost Location

Source: https://thrift.apache.org/docs/BuildingFromSource

If Boost libraries are installed in a non-standard location, use the --with-boost=<path> option to specify the directory. For example, if Boost is in /usr/local, use --with-boost=/usr/local.

```bash
./configure --with-boost=/usr/local
```

--------------------------------

### Install Haxe

Source: https://thrift.apache.org/docs/install/debian.html

Installs Haxe, a high-level, cross-platform programming language, for Haxe development with Apache Thrift.

```bash
haxe

```

--------------------------------

### Download and Install Bison 2.5.1

Source: https://thrift.apache.org/docs/install/centos.html

Downloads, compiles, and installs Bison version 2.5.1, a prerequisite for building Apache Thrift.

```bash
wget http://ftp.gnu.org/gnu/bison/bison-2.5.1.tar.gz
tar xvf bison-2.5.1.tar.gz
cd bison-2.5.1
./configure --prefix=/usr
make
sudo make install
cd ..

```

--------------------------------

### Install C++ Language Library Dependencies

Source: https://thrift.apache.org/docs/install/centos.html

Installs development libraries required for building Apache Thrift with C++ support.

```bash
sudo yum -y install libevent-devel zlib-devel openssl-devel

```

--------------------------------

### Install Core Debian/Ubuntu Tools and Libraries

Source: https://thrift.apache.org/docs/install/debian.html

Installs essential tools and libraries for building the Apache Thrift compiler and C++ libraries on Debian/Ubuntu.

```bash
sudo apt-get install automake bison flex g++ git libboost-all-dev libevent-dev libssl-dev libtool make pkg-config

```

--------------------------------

### Install Lua 5.3 and Development Libraries

Source: https://thrift.apache.org/docs/install/debian.html

Installs Lua 5.3 and its development libraries, required for Lua development with Apache Thrift.

```bash
lua5.3 liblua5.3-dev

```

--------------------------------

### Download and Install Boost 1.56.0

Source: https://thrift.apache.org/docs/install/centos.html

Downloads, compiles, and installs Boost version 1.56.0, a dependency for C++ Thrift development.

```bash
wget http://sourceforge.net/projects/boost/files/boost/1.56.0/boost_1_56_0.tar.gz
tar xvf boost_1_56_0.tar.gz
cd boost_1_56_0
./bootstrap.sh
sudo ./b2 install

```

--------------------------------

### Install libevent on OS X

Source: https://thrift.apache.org/docs/install/os_x.html

Download, configure, and install the libevent library. This is a required dependency for Apache Thrift.

```bash
./configure --prefix=/usr/local 
make
sudo make install

```

--------------------------------

### Build Apache Thrift Compiler on OS X

Source: https://thrift.apache.org/docs/install/os_x.html

Configure, compile, and install the Apache Thrift compiler. Ensure Boost and libevent are installed and accessible.

```bash
./configure --prefix=/usr/local/ --with-boost=/usr/local --with-libevent=/usr/local

```

--------------------------------

### Install Development Tools on CentOS

Source: https://thrift.apache.org/docs/install/centos.html

Installs the 'Development Tools' group, which includes essential compilers and utilities for building software from source.

```bash
sudo yum -y groupinstall "Development Tools"

```

--------------------------------

### Manually Install Perl Libraries

Source: https://thrift.apache.org/docs/install/windows.html

Replace the default Makefile with this content if you need to manually manage Perl library installation after building Thrift.

```makefile
TODO

```

--------------------------------

### Build and Install Apache Thrift IDL Compiler

Source: https://thrift.apache.org/docs/install/centos.html

Clones the Apache Thrift repository, configures the build, and installs the IDL compiler and language libraries.

```bash
git clone https://github.com/apache/thrift.git
cd thrift
./bootstrap.sh
./configure --with-lua=no
make
sudo make install

```

--------------------------------

### Install Rust Compiler and Cargo

Source: https://thrift.apache.org/docs/install/debian.html

Installs the Rust compiler (rustc) and Cargo, the Rust package manager, for Rust development with Apache Thrift.

```bash
rustc cargo

```

--------------------------------

### Export Java Path

Source: https://thrift.apache.org/docs/install/windows.html

Ensure Java is in your PATH by exporting the path. Adjust the path as necessary for your JRE installation.

```bash
export PATH=$PATH:"/cygdrive/c/program files/java/jre1.8.0_191/bin"

```

--------------------------------

### Configure Thrift Build - Override Java SDK Detection

Source: https://thrift.apache.org/docs/BuildingFromSource

To manually specify the Java SDK compiler, use the JAVAC environment variable when running the configure script. For example, JAVAC=/usb/bin/javac.

```bash
./configure JAVAC=/usb/bin/javac
```

--------------------------------

### Configure Thrift without Perl Libraries

Source: https://thrift.apache.org/docs/install/windows.html

Use this option if Perl libraries are not required for your Thrift installation to avoid potential build issues.

```bash
--without-perl
```

--------------------------------

### Update CentOS System

Source: https://thrift.apache.org/docs/install/centos.html

Ensures the system is up-to-date before proceeding with installations.

```bash
sudo yum -y update

```

--------------------------------

### Configure Thrift Build - Disable Language

Source: https://thrift.apache.org/docs/BuildingFromSource

Use the --without-<language> option with the configure script to exclude specific language support from the build. For example, to disable Java support, use --without-java.

```bash
./configure --without-java
```

--------------------------------

### Configure Thrift Build - Customize C++ Compiler Flags

Source: https://thrift.apache.org/docs/BuildingFromSource

Customize compiler flags for C++ builds using CXXFLAGS, CFLAGS, and CPPFLAGS. For example, to include debugging symbols and optimization, use CXXFLAGS='-g -O2'. Use CPPFLAGS='-DDEBUG_MY_FEATURE' to define preprocessor macros.

```bash
./configure CXXFLAGS='-g -O2'
```

```bash
./configure CFLAGS='-g -O2'
```

```bash
./configure CPPFLAGS='-DDEBUG_MY_FEATURE'
```

--------------------------------

### Display Configuration Options

Source: https://thrift.apache.org/docs/BuildingFromSource

Run the configure script with the --help flag to view all available configuration options and their descriptions.

```bash
./configure --help
```

--------------------------------

### Build Thrift with Make

Source: https://thrift.apache.org/docs/BuildingFromSource

After configuring, use the 'make' command from the top-level source directory to compile the Thrift project.

```bash
make
```

--------------------------------

### Generate Configure Scripts (Cygwin/MinGW)

Source: https://thrift.apache.org/docs/install/windows.html

Run this command from the top directory if building from the source repository for the first time to generate configure scripts. This is not necessary if you downloaded a tarball.

```bash
./bootstrap.sh

```

--------------------------------

### Build with MinGW Make

Source: https://thrift.apache.org/docs/install/windows.html

Use mingw32-make.exe to build Thrift when using the MinGW environment.

```makefile
mingw32-make.exe

```

--------------------------------

### Configure Thrift Build

Source: https://thrift.apache.org/docs/BuildingFromSource

Run the configure script from the top-level source directory to prepare Thrift for building. This script checks for dependencies and sets up build options.

```bash
./configure
```

--------------------------------

### Configure Thrift Build (Cygwin/MinGW)

Source: https://thrift.apache.org/docs/install/windows.html

After generating configure scripts, run this command from the top directory to configure the Thrift build. The CXXFLAGS environment variable is set to work around a specific compile error.

```bash
export CXXFLAGS="-D PTHREAD_MUTEX_RECURSIVE_NP=PTHREAD_MUTEX_RECURSIVE"
./configure

```

--------------------------------

### Build Only the Compiler

Source: https://thrift.apache.org/docs/install/windows.html

Navigate to the compiler directory before running make if you only intend to build the compiler.

```bash
cd compiler/cpp

```

--------------------------------

### Generate Configuration Scripts

Source: https://thrift.apache.org/docs/BuildingFromSource

Run this command from the top-level source directory to generate the configure scripts when building from a source repository for the first time. This is not needed if you downloaded a released tarball.

```bash
./bootstrap.sh
```

--------------------------------

### Run Thrift Test Suite

Source: https://thrift.apache.org/docs/BuildingFromSource

Execute the 'make check' command to run the unit tests for the Thrift build. This verifies the core functionality of the compiled components.

```bash
make check
```

--------------------------------

### Copy pkg.m4 for Configure Fix (Cygwin)

Source: https://thrift.apache.org/docs/install/windows.html

If you encounter a syntax error during the './configure' step related to PKG_CHECK_MODULES, copy the pkg.m4 file from the system's aclocal directory to the thrift/aclocal directory. This file is provided by the pkg-config package.

```bash
cp /usr/share/aclocal/pkg.m4 aclocal

```

--------------------------------

### Run Cross-Language Test Suite

Source: https://thrift.apache.org/docs/BuildingFromSource

Use this command to run the cross-language test suite, which verifies Thrift's interoperability between different language implementations.

```bash
python3 test/test.py
```

--------------------------------

### Add MinGW to Windows PATH

Source: https://thrift.apache.org/docs/install/windows.html

Add this entry to your Windows PATH environment variable to include MinGW's binary directory.

```text
C:\MINGW\BIN

```

--------------------------------

### Create Patch File

Source: https://thrift.apache.org/docs/HowToContribute.html

To create a patch file from local changes, use the 'git diff' command. This patch can then be shared for review.

```bash
git diff > ../THRIFT-NNNN.patch

```

--------------------------------

### Apache Thrift Network Stack Diagram

Source: https://thrift.apache.org/docs/concepts.html

A visual representation of the Apache Thrift networking stack, illustrating the layered architecture from the Server down to the Transport.

```text
+-------------------------------------------+
| Server                                    |
| (single-threaded, event-driven etc)       |
+-------------------------------------------+
| Processor                                 |
| (compiler generated)                      |
+-------------------------------------------+
| Protocol                                  |
| (JSON, compact etc)                       |
+-------------------------------------------+
| Transport                                 |
| (raw TCP, HTTP etc)                       |
+-------------------------------------------+
```

--------------------------------

### Configure Thrift Build - Enable Libtool Lock

Source: https://thrift.apache.org/docs/BuildingFromSource

If you encounter issues with parallel make during the Thrift Runtime Library build, re-run configure with the --enable-libtool-lock option. This can resolve 'No such file or directory' errors related to .deps files.

```bash
--enable-libtool-lock
```

--------------------------------

### Thrift Include Syntax

Source: https://thrift.apache.org/docs/idl

An include statement makes symbols from another file visible with a prefix and adds include statements to generated code.

```thrift
[3]  Include         ::=  'include' Literal
```

--------------------------------

### C++ Include Syntax

Source: https://thrift.apache.org/docs/idl

A C++ include adds a custom C++ include directive to the generated C++ code.

```thrift
[4]  CppInclude      ::=  'cpp_include' Literal
```

--------------------------------

### Add MinGW Flags to CXXDEFS

Source: https://thrift.apache.org/docs/install/windows.html

Add -DMINGW -mno-cygwin to the CXXDEFS variable in Makefile to resolve 'realpath is not found' errors.

```makefile
-DMINGW -mno-cygwin

```

--------------------------------

### Thrift Protocol Interface Methods

Source: https://thrift.apache.org/docs/concepts.html

Defines the methods for writing and reading data structures according to a specific protocol. Used for serialization and deserialization of data.

```thrift
writeMessageBegin(name, type, seq)
writeMessageEnd()
writeStructBegin(name)
writeStructEnd()
writeFieldBegin(name, type, id)
writeFieldEnd()
writeFieldStop()
writeMapBegin(ktype, vtype, size)
writeMapEnd()
writeListBegin(etype, size)
writeListEnd()
writeSetBegin(etype, size)
writeSetEnd()
writeBool(bool)
writeByte(byte)
writeI16(i16)
writeI32(i32)
writeI64(i64)
writeDouble(double)
writeString(string)

name, type, seq = readMessageBegin()
                  readMessageEnd()
name = readStructBegin()
       readStructEnd()
name, type, id = readFieldBegin()
                 readFieldEnd()
k, v, size = readMapBegin()
             readMapEnd()
etype, size = readListBegin()
              readListEnd()
etype, size = readSetBegin()
              readSetEnd()
bool = readBool()
byte = readByte()
i16 = readI16()
i32 = readI32()
i64 = readI64()
double = readDouble()
string = readString()
```

--------------------------------

### Adjust Boost Include Directory for MinGW

Source: https://thrift.apache.org/docs/install/windows.html

Modify the BOOST_CPPFLAGS in compiler/cpp/Makefile to use the Windows path for the Boost include directory if Boost is not found.

```makefile
BOOST_CPPFLAGS = -Ic:/cygwin/usr/include/boost-1_53_0

```

--------------------------------

### Link C++ Runtime Libraries Directly

Source: https://thrift.apache.org/docs/install/windows.html

Use these lines in a Makefile to link compiled object files directly, bypassing potential issues with linking libthrift.a using g++.

```makefile
THRIFT_O=<path to>/thrift/lib/cpp
LTHRIFT=$(THRIFT_O)/Thrift.o $(THRIFT_O)/TSocket.o $(THRIFT_O)/TBinaryProtocol.o $(THRIFT_O)/TBufferTransports.o

```

--------------------------------

### Add -lfl to CXXFLAGS for yywrap

Source: https://thrift.apache.org/docs/install/windows.html

Ensure -lfl is included in your cxxflags in Makefile and consider adding -Lc:/cygwin/libs if the 'yywrap is not found' error persists.

```makefile
-lfl

```

--------------------------------

### Thrift Function Definition Syntax

Source: https://thrift.apache.org/docs/idl

Specifies the grammar for defining functions within a Thrift IDL file, including optional 'oneway' keyword, return types, identifiers, parameters, and exceptions.

```thrift
[20] Function        ::=  'oneway'? FunctionType Identifier '(' Field* ')' Throws? ListSeparator?

[21] FunctionType    ::=  FieldType | 'void'

[22] Throws          ::=  'throws' '(' Field* ')'

```

--------------------------------

### Thrift Service Definition

Source: https://thrift.apache.org/docs/idl

Defines a service, which specifies an interface for server functionality. Services can extend other services.

```thrift
[14] Service         ::=  'service' Identifier ( 'extends' Identifier )? '{' Function* '}'
```

--------------------------------

### Build Thrift Runtime without Parallel Make

Source: https://thrift.apache.org/docs/BuildingFromSource

Alternatively, to avoid issues with parallel make during the Thrift Runtime Library build, you can disable it by adding '.NOTPARALLEL:' to lib/cpp/Makefile or by running 'make -j 1'.

```bash
make -j 1
```

--------------------------------

### Thrift Namespace Declaration

Source: https://thrift.apache.org/docs/idl

Declares namespaces or package names for target languages. A '*' scope applies to all languages.

```thrift
[5]  Namespace       ::=  ( 'namespace' ( NamespaceScope Identifier ) )
```

```thrift
[6]  NamespaceScope  ::=  '*' | 'c_glib' | 'cpp' | 'delphi' | 'haxe' | 'go' | 'java' | 'js' | 'lua' | 'netstd' | 'perl' | 'php' | 'py' | 'py.twisted' | 'rb' | 'st' | 'xsd'
```

--------------------------------

### Thrift XSD Field Options Syntax

Source: https://thrift.apache.org/docs/idl

Defines the syntax for XSD field options in Thrift. These options have internal purposes at Facebook and are discouraged for general use.

```thrift
[18] XsdFieldOptions ::=  'xsd_optional'? 'xsd_nillable'? XsdAttrs?

[19] XsdAttrs        ::=  'xsd_attrs' '{' Field* '}'

```

--------------------------------

### Thrift Constant Value Definitions

Source: https://thrift.apache.org/docs/idl

Details the syntax for defining constant values in Thrift, including integers, doubles, literals, identifiers, lists, and maps.

```thrift
[31] ConstValue      ::=  IntConstant | DoubleConstant | Literal | Identifier | ConstList | ConstMap

[32] IntConstant     ::=  ('+' | '-')? Digit+

[33] DoubleConstant  ::=  ('+' | '-')? Digit* ('.' Digit+)? ( ('E' | 'e') IntConstant )?

[34] ConstList       ::=  '[' (ConstValue ListSeparator?)* ']'

[35] ConstMap        ::=  '{' (ConstValue ':' ConstValue ListSeparator?)* '}'

```

--------------------------------

### Thrift Document Structure

Source: https://thrift.apache.org/docs/idl

A Thrift document consists of zero or more headers followed by zero or more definitions.

```thrift
[1]  Document        ::=  Header* Definition*
```

--------------------------------

### Thrift Header Types

Source: https://thrift.apache.org/docs/idl

Headers in a Thrift document can be includes, C++ includes, or namespace declarations.

```thrift
[2]  Header          ::=  Include | CppInclude | Namespace
```

--------------------------------

### Add Thrift CXXFLAGS for MinGW

Source: https://thrift.apache.org/docs/install/windows.html

Add this line to thrift_CXXFLAGS in compiler/cpp/Makefile.am when compiling with MinGW to enable specific flags.

```makefile
-DMINGW -mno-cygwin -lfl

```

--------------------------------

### Thrift Typedef Syntax

Source: https://thrift.apache.org/docs/idl

Creates an alternate name for an existing type.

```thrift
[9]  Typedef         ::=  'typedef' DefinitionType Identifier
```

--------------------------------

### Thrift Letter and Digit Definitions

Source: https://thrift.apache.org/docs/idl

Defines the character sets for letters and digits used in Thrift IDL syntax.

```thrift
[40] Letter          ::=  ['A'-'Z'] | ['a'-'z']

[41] Digit           ::=  ['0'-'9']

```

--------------------------------

### Pull Request Title Format

Source: https://thrift.apache.org/docs/HowToContribute.html

When submitting a pull request, the title must begin with the Jira THRIFT ticket identifier if one exists.

```text
THRIFT-9999: an example pull request title

```

--------------------------------

### Rebase Pull Request

Source: https://thrift.apache.org/docs/HowToContribute.html

Rebase your pull request to resolve conflicts with the master branch. Ensure the code builds after resolving any conflicts.

```bash
git checkout THRIFT-9999
git rebase upstream master
  (resolve any conflicts, make sure it builds)
git push -u origin THRIFT-9999 --force

```

--------------------------------

### Thrift List Separator Definition

Source: https://thrift.apache.org/docs/idl

Defines the allowed characters for separating elements in lists and maps within Thrift IDL.

```thrift
[39] ListSeparator   ::=  ',' | ';'

```

--------------------------------

### Thrift Processor Interface Definition

Source: https://thrift.apache.org/docs/concepts.html

Defines the TProcessor interface, which handles reading from input streams and writing to output streams using Protocol objects. Used for request processing.

```java
interface TProcessor {
    bool process(TProtocol in, TProtocol out) throws TException
}
```

--------------------------------

### Thrift Exception Definition

Source: https://thrift.apache.org/docs/idl

Defines an exception, similar to structs but intended for native exception handling mechanisms.

```thrift
[13] Exception       ::=  'exception' Identifier '{' Field* '}'
```

--------------------------------

### Force Push Squashed Commit

Source: https://thrift.apache.org/docs/HowToContribute.html

Use this command to overwrite an existing pull request with a single, squashed commit after changing your commit history.

```bash
git push -u origin THRIFT-9999 --force

```

--------------------------------

### Fix Bad Merge with Cherry-Pick

Source: https://thrift.apache.org/docs/HowToContribute.html

Use this procedure to fix a bad merge by cherry-picking your commits, squashing them, and force pushing to your pull request branch.

```bash
git checkout master
git pull upstream master
git checkout -b THRIFT-9999-take-2
git cherry-pick ...
    (pick only your commits from your original pull request in ascending chronological order)
squash your changes to a single commit if there is more than one (see above)
git push -u origin THRIFT-9999-take-2:THRIFT-9999

```

--------------------------------

### Thrift Data Type Definitions

Source: https://thrift.apache.org/docs/idl

Defines the structure for various data types in Thrift, including base types, container types (map, set, list), and custom C++ types.

```thrift
[23] FieldType       ::=  Identifier | BaseType | ContainerType

[24] DefinitionType  ::=  BaseType | ContainerType

[25] BaseType        ::=  'bool' | 'byte' | 'i8' | 'i16' | 'i32' | 'i64' | 'double' | 'string' | 'binary' | 'uuid'

[26] ContainerType   ::=  MapType | SetType | ListType

[27] MapType         ::=  'map' CppType? '<' FieldType ',' FieldType '>'

[28] SetType         ::=  'set' CppType? '<' FieldType '>'

[29] ListType        ::=  'list' CppType? '<' FieldType '>'

[30] CppType         ::=  'cpp_type' Literal

```

--------------------------------

### Thrift Field ID Syntax

Source: https://thrift.apache.org/docs/idl

Specifies a unique integer identifier for a field, followed by a colon.

```thrift
[16] FieldID         ::=  IntConstant ':'
```

--------------------------------

### Thrift Identifier Definitions

Source: https://thrift.apache.org/docs/idl

Specifies the rules for valid identifiers in Thrift, including standard identifiers and those with hyphens.

```thrift
[37] Identifier      ::=  ( Letter | '_' ) ( Letter | Digit | '.' | '_' )*

[38] STIdentifier    ::=  ( Letter | '_' ) ( Letter | Digit | '.' | '_' | '-' )*

```

--------------------------------

### Thrift Constant Definition

Source: https://thrift.apache.org/docs/idl

Defines a constant value with a specified type, identifier, and value.

```thrift
[8]  Const           ::=  'const' FieldType Identifier '=' ConstValue ListSeparator?
```

--------------------------------

### Commit Message Format

Source: https://thrift.apache.org/docs/HowToContribute.html

Commit messages for code changes must follow a specific pattern, including the Jira ticket identifier, a summary, and the affected client languages.

```text
THRIFT-9999: [summary of fix, one line if possible]
Client: [language(s) affected, comma separated, for example: "cpp,erl,perl"]

```

--------------------------------

### Thrift Literal Definition

Source: https://thrift.apache.org/docs/idl

Defines the syntax for string literals in Thrift, which can be enclosed in either double quotes or single quotes.

```thrift
[36] Literal         ::=  ('"' [^"]* "") | (''' [^']* ''')

```

--------------------------------

### Thrift Field Definition

Source: https://thrift.apache.org/docs/idl

Defines a field within a struct, union, exception, or service function. Includes optional ID, requiredness, type, name, and default value.

```thrift
[15] Field           ::=  FieldID? FieldReq? FieldType Identifier ('=' ConstValue)? XsdFieldOptions ListSeparator?
```

--------------------------------

### Thrift Field Requiredness

Source: https://thrift.apache.org/docs/idl

Specifies the requiredness of a field as 'required', 'optional', or implicitly 'default'.

```thrift
[17] FieldReq        ::=  'required' | 'optional'
```

--------------------------------

### Thrift Definition Types

Source: https://thrift.apache.org/docs/idl

Defines the various types of definitions allowed within a Thrift document.

```thrift
[7]  Definition      ::=  Const | Typedef | Enum | Struct | Union | Exception | Service
```

--------------------------------

### Thrift Union Definition

Source: https://thrift.apache.org/docs/idl

Defines a union, similar to structs but allowing only one field to be set at a time. Members are implicitly optional.

```thrift
[12] Union          ::=  'union' Identifier 'xsd_all'? '{' Field* '}'
```

--------------------------------

### Thrift Struct Definition

Source: https://thrift.apache.org/docs/idl

Defines a struct, which is a fundamental compositional type. Field names must be unique within a struct.

```thrift
[11] Struct          ::=  'struct' Identifier 'xsd_all'? '{' Field* '}'
```

--------------------------------

### Thrift Enum Definition

Source: https://thrift.apache.org/docs/idl

Defines an enumerated type with named values. Values default to 0 and increment if not specified.

```thrift
[10] Enum            ::=  'enum' Identifier '{' (Identifier ('=' IntConstant)? ListSeparator?)* '}'
```
Tokens:
Raw