setting Command - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide

Product type
Software
Portfolio
Locate
Product family
Geo Addressing
Product
Geo Addressing SDK
Version
5.0
Language
English
Product name
Geo Addressing SDK
Title
Geo Addressing SDK Developer Guide
Copyright
2023
First publish date
2007
ft:lastEdition
2024-07-12
ft:lastPublication
2024-07-12T13:44:57.839102
The setting command is used to modify a setting in an API.
Note: This command is not supported for the Geocode Service in the Addressing API.

To modify settings using the CLI, follow this format:

setting --n [Name of setting] --v [Value for setting] --d [Path to configuration dir] --t [Type of setting]
  • To remove a particular setting, set --v to an empty string, e.g., --v "".
  • To define a country setting, use the country ISO 3 code with --t [Type of setting].
  • To enable or disable a remote process for the USA geocoder (GeoStan), see more information.

Examples:

# Global settings
setting --n MAXIMUM_BATCH_SIZE --v 100 --d "/path/to/config/dir"
 
# or with type specified 
setting --n MAXIMUM_BATCH_SIZE --v 100 --d "/path/to/config/dir" --t GLOBAL
 
# Country-level settings (use iso3 country code)
setting --n RETURN_EXTENDED_DATA --v no --d "/path/to/config/dir" --t USA

# Set the max pool size for optimal performance, default: 5
setting --n POOL_MAX_ACTIVE --v "8" --d "/path/to/config/dir" --t USA
 
# Core settings
setting --n COUNTRY_FALLBACK_MODE --v BASIC --d "/path/to/config/dir" --t CORE_SETTINGS

# Root settings
setting --n "root1" --v "/new_root1_path" --d "/path/to/config/dir" --t ROOTS