LocationCache Class

Inheritance
builtins.object
LocationCache

Constructor

LocationCache(preferred_locations, default_endpoint, enable_endpoint_discovery, use_multiple_write_locations, refresh_time_interval_in_ms)

Parameters

preferred_locations
default_endpoint
enable_endpoint_discovery
use_multiple_write_locations
refresh_time_interval_in_ms

Methods

can_use_multiple_write_locations
can_use_multiple_write_locations_for_request
check_and_update_cache
clear_stale_endpoint_unavailability_info
current_time_millis
get_endpoint_by_location
get_ordered_read_endpoints
get_ordered_write_endpoints
get_preferred_available_endpoints
get_preferred_locations
get_read_endpoint
get_read_endpoints
get_write_endpoint
get_write_endpoints
is_endpoint_unavailable
mark_endpoint_unavailable
mark_endpoint_unavailable_for_read
mark_endpoint_unavailable_for_write
perform_on_database_account_read
resolve_service_endpoint
should_refresh_endpoints
update_location_cache

can_use_multiple_write_locations

can_use_multiple_write_locations()

can_use_multiple_write_locations_for_request

can_use_multiple_write_locations_for_request(request)

Parameters

request
Required

check_and_update_cache

check_and_update_cache()

clear_stale_endpoint_unavailability_info

clear_stale_endpoint_unavailability_info()

current_time_millis

current_time_millis()

get_endpoint_by_location

get_endpoint_by_location(locations)

Parameters

locations
Required

get_ordered_read_endpoints

get_ordered_read_endpoints()

get_ordered_write_endpoints

get_ordered_write_endpoints()

get_preferred_available_endpoints

get_preferred_available_endpoints(endpoints_by_location, orderedLocations, expected_available_operation, fallback_endpoint)

Parameters

endpoints_by_location
Required
orderedLocations
Required
expected_available_operation
Required
fallback_endpoint
Required

get_preferred_locations

get_preferred_locations()

get_read_endpoint

get_read_endpoint()

get_read_endpoints

get_read_endpoints()

get_write_endpoint

get_write_endpoint()

get_write_endpoints

get_write_endpoints()

is_endpoint_unavailable

is_endpoint_unavailable(endpoint, expected_available_operations)

Parameters

endpoint
Required
expected_available_operations
Required

mark_endpoint_unavailable

mark_endpoint_unavailable(unavailable_endpoint, unavailable_operation_type)

Parameters

unavailable_endpoint
Required
unavailable_operation_type
Required

mark_endpoint_unavailable_for_read

mark_endpoint_unavailable_for_read(endpoint)

Parameters

endpoint
Required

mark_endpoint_unavailable_for_write

mark_endpoint_unavailable_for_write(endpoint)

Parameters

endpoint
Required

perform_on_database_account_read

perform_on_database_account_read(database_account)

Parameters

database_account
Required

resolve_service_endpoint

resolve_service_endpoint(request)

Parameters

request
Required

should_refresh_endpoints

should_refresh_endpoints()

update_location_cache

update_location_cache(write_locations=None, read_locations=None, enable_multiple_writable_locations=None)

Parameters

write_locations
default value: None
read_locations
default value: None
enable_multiple_writable_locations
default value: None