duckdb::FileFlags Class Reference

Collaboration diagram for duckdb::FileFlags:

Static Public Attributes
static constexpr FileOpenFlags	FILE_FLAGS_READ = FileOpenFlags(FileOpenFlags::FILE_FLAGS_READ)
	Open file with read access.
static constexpr FileOpenFlags	FILE_FLAGS_WRITE = FileOpenFlags(FileOpenFlags::FILE_FLAGS_WRITE)
	Open file with write access.
static constexpr FileOpenFlags	FILE_FLAGS_DIRECT_IO = FileOpenFlags(FileOpenFlags::FILE_FLAGS_DIRECT_IO)
	Use direct IO when reading/writing to the file.
static constexpr FileOpenFlags	FILE_FLAGS_FILE_CREATE = FileOpenFlags(FileOpenFlags::FILE_FLAGS_FILE_CREATE)
	Create file if not exists, can only be used together with WRITE.
static constexpr FileOpenFlags	FILE_FLAGS_FILE_CREATE_NEW
	Always create a new file. If a file exists, the file is truncated. Cannot be used together with CREATE.
static constexpr FileOpenFlags	FILE_FLAGS_APPEND = FileOpenFlags(FileOpenFlags::FILE_FLAGS_APPEND)
	Open file in append mode.
static constexpr FileOpenFlags	FILE_FLAGS_PRIVATE = FileOpenFlags(FileOpenFlags::FILE_FLAGS_PRIVATE)
	Open file with restrictive permissions (600 on linux/mac) can only be used when creating, throws if file exists.
static constexpr FileOpenFlags	FILE_FLAGS_NULL_IF_NOT_EXISTS
	Return NULL if the file does not exist instead of throwing an error.
static constexpr FileOpenFlags	FILE_FLAGS_PARALLEL_ACCESS
	Multiple threads may perform reads and writes in parallel.
static constexpr FileOpenFlags	FILE_FLAGS_EXCLUSIVE_CREATE
	Ensure that this call creates the file, throw is file exists.
static constexpr FileOpenFlags	FILE_FLAGS_NULL_IF_EXISTS = FileOpenFlags(FileOpenFlags::FILE_FLAGS_NULL_IF_EXISTS)
	Return NULL if the file exist instead of throwing an error.
static constexpr FileOpenFlags	FILE_FLAGS_MULTI_CLIENT_ACCESS
	Multiple clients may access the file at the same time.
static constexpr FileOpenFlags	FILE_FLAGS_DISABLE_LOGGING
	Disables logging to avoid infinite loops when using FileHandle-backed log storage.
static constexpr FileOpenFlags	FILE_FLAGS_ENABLE_EXTENSION_INSTALL
	Opened file is allowed to be a duckdb_extension.

Member Data Documentation

FILE_FLAGS_FILE_CREATE_NEW

constexpr FileOpenFlags duckdb::FileFlags::FILE_FLAGS_FILE_CREATE_NEW

staticconstexpr

Initial value:

=
        FileOpenFlags(FileOpenFlags::FILE_FLAGS_FILE_CREATE_NEW)

Always create a new file. If a file exists, the file is truncated. Cannot be used together with CREATE.

FILE_FLAGS_NULL_IF_NOT_EXISTS

constexpr FileOpenFlags duckdb::FileFlags::FILE_FLAGS_NULL_IF_NOT_EXISTS

staticconstexpr

Initial value:

=
        FileOpenFlags(FileOpenFlags::FILE_FLAGS_NULL_IF_NOT_EXISTS)

Return NULL if the file does not exist instead of throwing an error.

FILE_FLAGS_PARALLEL_ACCESS

constexpr FileOpenFlags duckdb::FileFlags::FILE_FLAGS_PARALLEL_ACCESS

staticconstexpr

Initial value:

=
        FileOpenFlags(FileOpenFlags::FILE_FLAGS_PARALLEL_ACCESS)

Multiple threads may perform reads and writes in parallel.

FILE_FLAGS_EXCLUSIVE_CREATE

constexpr FileOpenFlags duckdb::FileFlags::FILE_FLAGS_EXCLUSIVE_CREATE

staticconstexpr

Initial value:

=
        FileOpenFlags(FileOpenFlags::FILE_FLAGS_EXCLUSIVE_CREATE)

Ensure that this call creates the file, throw is file exists.

FILE_FLAGS_MULTI_CLIENT_ACCESS

constexpr FileOpenFlags duckdb::FileFlags::FILE_FLAGS_MULTI_CLIENT_ACCESS

staticconstexpr

Initial value:

=
        FileOpenFlags(FileOpenFlags::FILE_FLAGS_MULTI_CLIENT_ACCESS)

Multiple clients may access the file at the same time.

FILE_FLAGS_DISABLE_LOGGING

constexpr FileOpenFlags duckdb::FileFlags::FILE_FLAGS_DISABLE_LOGGING

staticconstexpr

Initial value:

=
        FileOpenFlags(FileOpenFlags::FILE_FLAGS_DISABLE_LOGGING)

Disables logging to avoid infinite loops when using FileHandle-backed log storage.

FILE_FLAGS_ENABLE_EXTENSION_INSTALL

constexpr FileOpenFlags duckdb::FileFlags::FILE_FLAGS_ENABLE_EXTENSION_INSTALL

staticconstexpr

Initial value:

=
        FileOpenFlags(FileOpenFlags::FILE_FLAGS_ENABLE_EXTENSION_INSTALL)

Opened file is allowed to be a duckdb_extension.

---

The documentation for this class was generated from the following files:

• external/duckdb/duckdb.hpp
• external/duckdb/duckdb.cpp