datacube.index.index_connect¶
-
datacube.index.
index_connect
(local_config=None, application_name=None, validate_connection=True)[source]¶ Create a Data Cube Index that can connect to a PostgreSQL server
It contains all the required connection parameters, but doesn’t actually check that the server is available.
- Parameters
application_name (
Optional
[str
]) – A short, alphanumeric name to identify this application.local_config (
Optional
[LocalConfig
]) – Config object to use. (optional)validate_connection (
bool
) – Validate database connection and schema immediately
- Raises
datacube.index.Exceptions.IndexSetupError –
- Return type
Index