Configuration parameters#

See otp.config for details.

OptionsTable#

Name

Environment Variable

Description

otp.config.tz

OTP_DEFAULT_TZ

Default timezone used for running queries and creating databases, e.g. with otp.run. Default value is the local timezone of your machine.

otp.config.context

OTP_CONTEXT

Default context used for running queries, e.g. with otp.run.Note: In WebAPI mode it will have None value.

otp.config.default_start_time

OTP_DEFAULT_START_TIME

Default start time used for running queries, e.g. with otp.run.

otp.config.default_end_time

OTP_DEFAULT_END_TIME

Default end time used for running queries, e.g. with otp.run.

otp.config.default_db

OTP_DEFAULT_DB

Default database name used for running queries, e.g. with otp.run.

otp.config.default_symbol

OTP_DEFAULT_SYMBOL

Default symbol name used for running queries, e.g. with otp.run.

otp.config.default_symbology

OTP_DEFAULT_SYMBOLOGY

Default database symbology.

otp.config.default_concurrency

OTP_DEFAULT_CONCURRENCY

Default concurrency level used for running queries, e.g. with otp.run. Default value is None which means that the value is adaptive and is set to 0 (meaning concurrency will be auto-assigned by OneTick server) on the latest OneTick versions where it is supported or to 1 (meaning no concurrency) on older versions.

otp.config.default_batch_size

OTP_DEFAULT_BATCH_SIZE

Default batch size used for running queries, e.g. with otp.run. Batch size is the maximum number of symbols that are processed at once. The value of 0 means unlimited – works faster for simple queries, but may consume too much memory for complex queries.

otp.config.default_license_dir

OTP_DEFAULT_LICENSE_DIR

Default path for license directory. Needed for user to be allowed to use OneTick API. Default value is system-dependent: /license for Linux systems and C:/OMD/client_data/config/license_repository for Windows systems.

otp.config.default_license_file

OTP_DEFAULT_LICENSE_FILE

Default path for license file. Needed for user to be allowed to use OneTick API. Default value is system-dependent: /license/license.dat for Linux systems and C:/OMD/client_data/config/license.dat for Windows systems.

otp.config.default_fault_tolerance

OTP_DEFAULT_FAULT_TOLERANCE

Default value for USE_FT query property.

otp.config.default_auth_username

OTP_DEFAULT_AUTH_USERNAME

Default username used for authentication.

otp.config.default_password

OTP_DEFAULT_PASSWORD

Default password used for authentication.

otp.config.http_address

OTP_HTTP_ADDRESS

Default HTTP server used as WebAPI endpoint.

otp.config.http_username

OTP_HTTP_USERNAME

Username used for WebAPI authentication.

otp.config.http_password

OTP_HTTP_PASSWORD

Password used for WebAPI authentication.

otp.config.http_proxy

HTTP_PROXY

HTTP proxy used for WebAPI requests.

otp.config.https_proxy

HTTPS_PROXY

HTTPS proxy used for WebAPI requests.

otp.config.access_token

OTP_ACCESS_TOKEN

SSO access token for WebAPI endpoint.

otp.config.client_id

OTP_CLIENT_ID

Client ID for obtaining SSO access token.

otp.config.client_secret

OTP_CLIENT_SECRET

Client Secret for obtaining SSO access token.

otp.config.access_token_url

OTP_ACCESS_TOKEN_URL

URL for obtaining SSO access token.

otp.config.trusted_certificates_file

OTP_SSL_CERT_FILE

Path to the file with list of trusted Certificate Authority certificates for WebAPI requests.

otp.config.max_expected_ticks_per_symbol

OTP_MAX_EXPECTED_TICKS_PER_SYMBOL

Expected maximum number of ticks per symbol (used for performance optimizations).

otp.config.show_stack_info

OTP_SHOW_STACK_INFO

Show stack info (filename and line or stack trace) in OneTick exceptions.

otp.config.log_symbol

OTP_LOG_SYMBOL

Log currently executed symbol. Note, this only works with unbound symbols. Note, in this case otp.run does not produce the output so it should be used only for debugging purposes.

otp.config.ignore_ticks_in_unentitled_time_range

OTP_IGNORE_TICKS_IN_UNENTITLED_TIME_RANGE

Default value for IGNORE_TICKS_IN_UNENTITLED_TIME_RANGE query property.

otp.config.main_query_generated_filename

OTP_MAIN_QUERY_GENERATED_FILENAME

The name of the .otq file with generated main query executed by otp.run.

otp.config.logging

OTP_LOGGING

The logging level string or path to the file with configuration. Check the documentation of python logging module for the configuration formats. JSON format (in the file with .json suffix) and python configparser formats are supported.

otp.config.otq_debug_mode

OTP_OTQ_DEBUG_MODE

Enable .otq files debug mode. If set to True, onetick.py will keep all generated otq files and log their paths to the console.

otp.config.allow_lowercase_in_saved_fields

None

Allow using lower case characters in field names that are being stored in Onetick databases. If set to False, onetick.py would not allow saving fields with lower case characters to a database.

otp.config.clean_up_tmp_files

OTP_CLEAN_UP_TMP_FILES

Control deleting temporary files created by onetick-py. Temporary files are OneTick configuration files and generated .otq queries.

otp.config.default_schema_policy

OTP_DEFAULT_SCHEMA_POLICY

Default schema policy when querying onetick database. See parameter schema_policy in otp.DataSource for the list of supported values.

otp.config.default_db_symbol

Default symbol with database. Defined with default_db and default_symbol as string default_db::default_symbol.

otp.config.default_date

Default date. Defined as a date part of default_start_time.