|
18 | 18 | imply the current dataset ID and connection from the enviroment. |
19 | 19 | """ |
20 | 20 |
|
| 21 | +import os |
21 | 22 | import socket |
22 | 23 |
|
23 | 24 | from six.moves.http_client import HTTPConnection # pylint: disable=F0401 |
|
28 | 29 | app_identity = None |
29 | 30 |
|
30 | 31 |
|
| 32 | +_DATASET_ENV_VAR_NAME = 'GCLOUD_DATASET_ID' |
| 33 | +_GCD_DATASET_ENV_VAR_NAME = 'DATASTORE_DATASET' |
| 34 | + |
| 35 | + |
31 | 36 | class _DefaultsContainer(object): |
32 | 37 | """Container for defaults. |
33 | 38 |
|
@@ -90,6 +95,61 @@ def compute_engine_id(): |
90 | 95 | connection.close() |
91 | 96 |
|
92 | 97 |
|
| 98 | +def _determine_default_dataset_id(dataset_id=None): |
| 99 | + """Determine default dataset ID explicitly or implicitly as fall-back. |
| 100 | +
|
| 101 | + In implicit case, supports four environments. In order of precedence, the |
| 102 | + implicit environments are: |
| 103 | +
|
| 104 | + * GCLOUD_DATASET_ID environment variable |
| 105 | + * DATASTORE_DATASET environment variable (for ``gcd`` testing) |
| 106 | + * Google App Engine application ID |
| 107 | + * Google Compute Engine project ID (from metadata server) |
| 108 | +
|
| 109 | + :type dataset_id: string |
| 110 | + :param dataset_id: Optional. The dataset ID to use as default. |
| 111 | +
|
| 112 | + :rtype: string or ``NoneType`` |
| 113 | + :returns: Default dataset ID if it can be determined. |
| 114 | + """ |
| 115 | + if dataset_id is None: |
| 116 | + dataset_id = os.getenv(_DATASET_ENV_VAR_NAME) |
| 117 | + |
| 118 | + if dataset_id is None: |
| 119 | + dataset_id = os.getenv(_GCD_DATASET_ENV_VAR_NAME) |
| 120 | + |
| 121 | + if dataset_id is None: |
| 122 | + dataset_id = app_engine_id() |
| 123 | + |
| 124 | + if dataset_id is None: |
| 125 | + dataset_id = compute_engine_id() |
| 126 | + |
| 127 | + return dataset_id |
| 128 | + |
| 129 | + |
| 130 | +def set_default_dataset_id(dataset_id=None): |
| 131 | + """Set default dataset ID either explicitly or implicitly as fall-back. |
| 132 | +
|
| 133 | + In implicit case, supports four environments. In order of precedence, the |
| 134 | + implicit environments are: |
| 135 | +
|
| 136 | + * GCLOUD_DATASET_ID environment variable |
| 137 | + * DATASTORE_DATASET environment variable (for ``gcd`` testing) |
| 138 | + * Google App Engine application ID |
| 139 | + * Google Compute Engine project ID (from metadata server) |
| 140 | +
|
| 141 | + :type dataset_id: string |
| 142 | + :param dataset_id: Optional. The dataset ID to use as default. |
| 143 | +
|
| 144 | + :raises: :class:`EnvironmentError` if no dataset ID was implied. |
| 145 | + """ |
| 146 | + dataset_id = _determine_default_dataset_id(dataset_id=dataset_id) |
| 147 | + if dataset_id is not None: |
| 148 | + _DEFAULTS.dataset_id = dataset_id |
| 149 | + else: |
| 150 | + raise EnvironmentError('No dataset ID could be inferred.') |
| 151 | + |
| 152 | + |
93 | 153 | def get_default_connection(): |
94 | 154 | """Get default connection. |
95 | 155 |
|
|
0 commit comments