java.lang.Object
- org.apache.iceberg.CatalogProperties

public class CatalogProperties
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`APP_ID`
`static java.lang.String`	`AUTH_DEFAULT_REFRESH_ENABLED`	Deprecated. Will be removed in 1.3.0; Use `OAuth2Properties.TOKEN_REFRESH_ENABLED` to control token refresh behavior.
`static boolean`	`AUTH_DEFAULT_REFRESH_ENABLED_DEFAULT`	Deprecated. Will be removed in 1.3.0; Use `OAuth2Properties.TOKEN_REFRESH_ENABLED_DEFAULT` to control default token refresh behavior.
`static java.lang.String`	`AUTH_SESSION_TIMEOUT_MS`
`static long`	`AUTH_SESSION_TIMEOUT_MS_DEFAULT`
`static java.lang.String`	`CACHE_ENABLED`	Controls whether the catalog will cache table entries upon load.
`static boolean`	`CACHE_ENABLED_DEFAULT`
`static java.lang.String`	`CACHE_EXPIRATION_INTERVAL_MS`	Controls the duration for which entries in the catalog are cached.
`static long`	`CACHE_EXPIRATION_INTERVAL_MS_DEFAULT`
`static long`	`CACHE_EXPIRATION_INTERVAL_MS_OFF`
`static java.lang.String`	`CATALOG_IMPL`
`static java.lang.String`	`CLIENT_POOL_CACHE_EVICTION_INTERVAL_MS`
`static long`	`CLIENT_POOL_CACHE_EVICTION_INTERVAL_MS_DEFAULT`
`static java.lang.String`	`CLIENT_POOL_SIZE`
`static int`	`CLIENT_POOL_SIZE_DEFAULT`
`static java.lang.String`	`FILE_IO_IMPL`
`static java.lang.String`	`IO_MANIFEST_CACHE_ENABLED`	Controls whether to use caching during manifest reads or not.
`static boolean`	`IO_MANIFEST_CACHE_ENABLED_DEFAULT`
`static java.lang.String`	`IO_MANIFEST_CACHE_EXPIRATION_INTERVAL_MS`	Controls the maximum duration for which an entry stays in the manifest cache.
`static long`	`IO_MANIFEST_CACHE_EXPIRATION_INTERVAL_MS_DEFAULT`
`static java.lang.String`	`IO_MANIFEST_CACHE_MAX_CONTENT_LENGTH`	Controls the maximum length of file to be considered for caching.
`static long`	`IO_MANIFEST_CACHE_MAX_CONTENT_LENGTH_DEFAULT`
`static java.lang.String`	`IO_MANIFEST_CACHE_MAX_TOTAL_BYTES`	Controls the maximum total amount of bytes to cache in manifest cache.
`static long`	`IO_MANIFEST_CACHE_MAX_TOTAL_BYTES_DEFAULT`
`static java.lang.String`	`LOCK_ACQUIRE_INTERVAL_MS`
`static long`	`LOCK_ACQUIRE_INTERVAL_MS_DEFAULT`
`static java.lang.String`	`LOCK_ACQUIRE_TIMEOUT_MS`
`static long`	`LOCK_ACQUIRE_TIMEOUT_MS_DEFAULT`
`static java.lang.String`	`LOCK_HEARTBEAT_INTERVAL_MS`
`static long`	`LOCK_HEARTBEAT_INTERVAL_MS_DEFAULT`
`static java.lang.String`	`LOCK_HEARTBEAT_THREADS`
`static int`	`LOCK_HEARTBEAT_THREADS_DEFAULT`
`static java.lang.String`	`LOCK_HEARTBEAT_TIMEOUT_MS`
`static long`	`LOCK_HEARTBEAT_TIMEOUT_MS_DEFAULT`
`static java.lang.String`	`LOCK_IMPL`
`static java.lang.String`	`LOCK_TABLE`
`static java.lang.String`	`METRICS_REPORTER_IMPL`
`static java.lang.String`	`TABLE_DEFAULT_PREFIX`
`static java.lang.String`	`TABLE_OVERRIDE_PREFIX`
`static java.lang.String`	`URI`
`static java.lang.String`	`USER`
`static java.lang.String`	`WAREHOUSE_LOCATION`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CATALOG_IMPL
```
public static final java.lang.String CATALOG_IMPL
```
    See Also:
    
    Constant Field Values
  - FILE_IO_IMPL
```
public static final java.lang.String FILE_IO_IMPL
```
    See Also:
    
    Constant Field Values
  - WAREHOUSE_LOCATION
```
public static final java.lang.String WAREHOUSE_LOCATION
```
    See Also:
    
    Constant Field Values
  - TABLE_DEFAULT_PREFIX
```
public static final java.lang.String TABLE_DEFAULT_PREFIX
```
    See Also:
    
    Constant Field Values
  - TABLE_OVERRIDE_PREFIX
```
public static final java.lang.String TABLE_OVERRIDE_PREFIX
```
    See Also:
    
    Constant Field Values
  - METRICS_REPORTER_IMPL
```
public static final java.lang.String METRICS_REPORTER_IMPL
```
    See Also:
    
    Constant Field Values
  - CACHE_ENABLED
```
public static final java.lang.String CACHE_ENABLED
```
    Controls whether the catalog will cache table entries upon load.
    If CACHE_EXPIRATION_INTERVAL_MS is set to zero, this value will be ignored and the cache will be disabled.
    
    See Also:
    
    Constant Field Values
  - CACHE_ENABLED_DEFAULT
```
public static final boolean CACHE_ENABLED_DEFAULT
```
    See Also:
    
    Constant Field Values
  - CACHE_EXPIRATION_INTERVAL_MS
```
public static final java.lang.String CACHE_EXPIRATION_INTERVAL_MS
```
    Controls the duration for which entries in the catalog are cached.
    Behavior of specific values of cache.expiration-interval-ms:
    
    Zero - Caching and cache expiration are both disabled
    Negative Values - Cache expiration is turned off and entries expire only on refresh etc
    Positive Values - Cache entries expire if not accessed via the cache after this many milliseconds
    See Also:
    
    Constant Field Values
  - CACHE_EXPIRATION_INTERVAL_MS_DEFAULT
```
public static final long CACHE_EXPIRATION_INTERVAL_MS_DEFAULT
```
  - CACHE_EXPIRATION_INTERVAL_MS_OFF
```
public static final long CACHE_EXPIRATION_INTERVAL_MS_OFF
```
    See Also:
    
    Constant Field Values
  - IO_MANIFEST_CACHE_ENABLED
```
public static final java.lang.String IO_MANIFEST_CACHE_ENABLED
```
    Controls whether to use caching during manifest reads or not.
    Enabling manifest file caching require the following configuration constraints to be true:
    
    IO_MANIFEST_CACHE_EXPIRATION_INTERVAL_MS must be a non-negative value.
    IO_MANIFEST_CACHE_MAX_TOTAL_BYTES must be a positive value.
    IO_MANIFEST_CACHE_MAX_CONTENT_LENGTH must be a positive value.
    See Also:
    
    Constant Field Values
  - IO_MANIFEST_CACHE_ENABLED_DEFAULT
```
public static final boolean IO_MANIFEST_CACHE_ENABLED_DEFAULT
```
    See Also:
    
    Constant Field Values
  - IO_MANIFEST_CACHE_EXPIRATION_INTERVAL_MS
```
public static final java.lang.String IO_MANIFEST_CACHE_EXPIRATION_INTERVAL_MS
```
    Controls the maximum duration for which an entry stays in the manifest cache.
    Must be a non-negative value. Following are specific behaviors of this config:
    
    Zero - Cache entries expires only if it gets evicted due to memory pressure from IO_MANIFEST_CACHE_MAX_TOTAL_BYTES setting.
    Positive Values - Cache entries expire if not accessed via the cache after this many milliseconds
    See Also:
    
    Constant Field Values
  - IO_MANIFEST_CACHE_EXPIRATION_INTERVAL_MS_DEFAULT
```
public static final long IO_MANIFEST_CACHE_EXPIRATION_INTERVAL_MS_DEFAULT
```
  - IO_MANIFEST_CACHE_MAX_TOTAL_BYTES
```
public static final java.lang.String IO_MANIFEST_CACHE_MAX_TOTAL_BYTES
```
    Controls the maximum total amount of bytes to cache in manifest cache.
    Must be a positive value.
    
    See Also:
    
    Constant Field Values
  - IO_MANIFEST_CACHE_MAX_TOTAL_BYTES_DEFAULT
```
public static final long IO_MANIFEST_CACHE_MAX_TOTAL_BYTES_DEFAULT
```
    See Also:
    
    Constant Field Values
  - IO_MANIFEST_CACHE_MAX_CONTENT_LENGTH
```
public static final java.lang.String IO_MANIFEST_CACHE_MAX_CONTENT_LENGTH
```
    Controls the maximum length of file to be considered for caching.
    An InputFile will not be cached if the length is longer than this limit. Must be a positive value.
    
    See Also:
    
    Constant Field Values
  - IO_MANIFEST_CACHE_MAX_CONTENT_LENGTH_DEFAULT
```
public static final long IO_MANIFEST_CACHE_MAX_CONTENT_LENGTH_DEFAULT
```
    See Also:
    
    Constant Field Values
  - URI
```
public static final java.lang.String URI
```
    See Also:
    
    Constant Field Values
  - CLIENT_POOL_SIZE
```
public static final java.lang.String CLIENT_POOL_SIZE
```
    See Also:
    
    Constant Field Values
  - CLIENT_POOL_SIZE_DEFAULT
```
public static final int CLIENT_POOL_SIZE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - CLIENT_POOL_CACHE_EVICTION_INTERVAL_MS
```
public static final java.lang.String CLIENT_POOL_CACHE_EVICTION_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - CLIENT_POOL_CACHE_EVICTION_INTERVAL_MS_DEFAULT
```
public static final long CLIENT_POOL_CACHE_EVICTION_INTERVAL_MS_DEFAULT
```
  - LOCK_IMPL
```
public static final java.lang.String LOCK_IMPL
```
    See Also:
    
    Constant Field Values
  - LOCK_HEARTBEAT_INTERVAL_MS
```
public static final java.lang.String LOCK_HEARTBEAT_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - LOCK_HEARTBEAT_INTERVAL_MS_DEFAULT
```
public static final long LOCK_HEARTBEAT_INTERVAL_MS_DEFAULT
```
  - LOCK_HEARTBEAT_TIMEOUT_MS
```
public static final java.lang.String LOCK_HEARTBEAT_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - LOCK_HEARTBEAT_TIMEOUT_MS_DEFAULT
```
public static final long LOCK_HEARTBEAT_TIMEOUT_MS_DEFAULT
```
  - LOCK_HEARTBEAT_THREADS
```
public static final java.lang.String LOCK_HEARTBEAT_THREADS
```
    See Also:
    
    Constant Field Values
  - LOCK_HEARTBEAT_THREADS_DEFAULT
```
public static final int LOCK_HEARTBEAT_THREADS_DEFAULT
```
    See Also:
    
    Constant Field Values
  - LOCK_ACQUIRE_INTERVAL_MS
```
public static final java.lang.String LOCK_ACQUIRE_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - LOCK_ACQUIRE_INTERVAL_MS_DEFAULT
```
public static final long LOCK_ACQUIRE_INTERVAL_MS_DEFAULT
```
  - LOCK_ACQUIRE_TIMEOUT_MS
```
public static final java.lang.String LOCK_ACQUIRE_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - LOCK_ACQUIRE_TIMEOUT_MS_DEFAULT
```
public static final long LOCK_ACQUIRE_TIMEOUT_MS_DEFAULT
```
  - LOCK_TABLE
```
public static final java.lang.String LOCK_TABLE
```
    See Also:
    
    Constant Field Values
  - APP_ID
```
public static final java.lang.String APP_ID
```
    See Also:
    
    Constant Field Values
  - USER
```
public static final java.lang.String USER
```
    See Also:
    
    Constant Field Values
  - AUTH_DEFAULT_REFRESH_ENABLED
```
@Deprecated
public static final java.lang.String AUTH_DEFAULT_REFRESH_ENABLED
```
    Deprecated.
    Will be removed in 1.3.0; Use OAuth2Properties.TOKEN_REFRESH_ENABLED to control token refresh behavior.
    
    See Also:
    
    Constant Field Values
  - AUTH_DEFAULT_REFRESH_ENABLED_DEFAULT
```
@Deprecated
public static final boolean AUTH_DEFAULT_REFRESH_ENABLED_DEFAULT
```
    Deprecated.
    Will be removed in 1.3.0; Use OAuth2Properties.TOKEN_REFRESH_ENABLED_DEFAULT to control default token refresh behavior.
    
    See Also:
    
    Constant Field Values
  - AUTH_SESSION_TIMEOUT_MS
```
public static final java.lang.String AUTH_SESSION_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - AUTH_SESSION_TIMEOUT_MS_DEFAULT
```
public static final long AUTH_SESSION_TIMEOUT_MS_DEFAULT
```

Class CatalogProperties

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CATALOG_IMPL

FILE_IO_IMPL

WAREHOUSE_LOCATION

TABLE_DEFAULT_PREFIX

TABLE_OVERRIDE_PREFIX

METRICS_REPORTER_IMPL

CACHE_ENABLED

CACHE_ENABLED_DEFAULT

CACHE_EXPIRATION_INTERVAL_MS

CACHE_EXPIRATION_INTERVAL_MS_DEFAULT

CACHE_EXPIRATION_INTERVAL_MS_OFF

IO_MANIFEST_CACHE_ENABLED

IO_MANIFEST_CACHE_ENABLED_DEFAULT

IO_MANIFEST_CACHE_EXPIRATION_INTERVAL_MS

IO_MANIFEST_CACHE_EXPIRATION_INTERVAL_MS_DEFAULT

IO_MANIFEST_CACHE_MAX_TOTAL_BYTES

IO_MANIFEST_CACHE_MAX_TOTAL_BYTES_DEFAULT

IO_MANIFEST_CACHE_MAX_CONTENT_LENGTH

IO_MANIFEST_CACHE_MAX_CONTENT_LENGTH_DEFAULT

URI

CLIENT_POOL_SIZE

CLIENT_POOL_SIZE_DEFAULT

CLIENT_POOL_CACHE_EVICTION_INTERVAL_MS

CLIENT_POOL_CACHE_EVICTION_INTERVAL_MS_DEFAULT

LOCK_IMPL

LOCK_HEARTBEAT_INTERVAL_MS

LOCK_HEARTBEAT_INTERVAL_MS_DEFAULT

LOCK_HEARTBEAT_TIMEOUT_MS

LOCK_HEARTBEAT_TIMEOUT_MS_DEFAULT

LOCK_HEARTBEAT_THREADS

LOCK_HEARTBEAT_THREADS_DEFAULT

LOCK_ACQUIRE_INTERVAL_MS

LOCK_ACQUIRE_INTERVAL_MS_DEFAULT

LOCK_ACQUIRE_TIMEOUT_MS

LOCK_ACQUIRE_TIMEOUT_MS_DEFAULT

LOCK_TABLE

APP_ID

USER

AUTH_DEFAULT_REFRESH_ENABLED

AUTH_DEFAULT_REFRESH_ENABLED_DEFAULT

AUTH_SESSION_TIMEOUT_MS

AUTH_SESSION_TIMEOUT_MS_DEFAULT