9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127 | class Admin(Client):
def __init__(self, uri: str, secure: bool = False, api_key: str = "", verbose: bool = True):
"""
Initialise the connexion to the Geocube Server
Args:
uri: of the Geocube Server
secure: True to use a TLS Connexion
api_key: (optional) API Key if Geocube Server is secured using a bearer authentication
verbose: display the version of the Geocube Server
"""
super().__init__(uri, secure, api_key, verbose)
self.admin_stub = Stub(admin_pb2_grpc.AdminStub(self._channel))
def set_timeout(self, timeout_sec: float):
super().set_timeout(timeout_sec)
self.admin_stub.timeout = timeout_sec
def admin_tidy(self, aois: bool = False, records: bool = False, variables: bool = False, instances: bool = False,
containers: bool = False, consolidation_params: bool = False, simulate: bool = True):
"""
Admin function to tidy the Geocube Database.
Remove all the entities that are not linked to any dataset.
Should be used with caution when no ingestion or indexation task is in progress.
Args:
aois: remove the pending AOI
records: remove the pending Records
variables: remove the pending Variables
instances: remove the pending Instances
containers: remove the pending Containers
consolidation_params: remove the pending ConsolidationParams
simulate: if True no operation is performed. Only the number of entities that would have been deleted
"""
return self._admin_tidy(aois, records, variables, instances, containers, consolidation_params, simulate)
def admin_update_datasets(self, instance: Union[str, entities.VariableInstance],
records: List[Union[str, entities.Record]],
dformat: Union[Dict, Tuple, str], min_out: float, max_out: float,
exponent: float, simulate: bool):
"""
Admin function to update some sensitive information of datasets referenced by an instance and a list of records
Args:
instance: select the datasets that are referenced by this instance
records: select the datasets that are referenced by these records
dformat: new dataformat
min_out: new min_out
max_out: new max_out
exponent: new exponent
simulate: if True, no operation is performed. Only display the datasets that would have been updated.
"""
self._admin_update_datasets(instance, records, dformat, min_out, max_out, exponent, simulate)
@deprecated("With Geocube > 1.0.2, use Client.delete_datasets instead")
def admin_delete_datasets(self, instances: List[Union[str, entities.VariableInstance]],
records: List[Union[str, entities.Record]],
file_patterns: List[str] = None,
execution_level: entities.ExecutionLevel = entities.ExecutionLevel.STEP_BY_STEP_CRITICAL,
job_name: str = None, allow_empty_instances=False, allow_empty_records=False) \
-> entities.Job:
"""
Admin function to delete datasets that are referenced by a list of instances and a list of records.
This function is provided without any guaranties of service continuity.
In the future, a secured function will be provided to safely delete datasets.
Args:
instances: select all the datasets referenced by these instances.
records: select all the datasets referenced by these records.
file_patterns: select all the datasets with on of the given file patterns
(support * and ? for all or any characters and trailing (?i) for case-insensitiveness)
execution_level: see entities.ExecutionLevel.
job_name: [optional] gives a name to the job, otherwise, a name will be automatically generated
allow_empty_instances: [optional] allows instances to be empty.
@warning It means that the job will delete all the instances for the given records.
allow_empty_records: [optional] allows records to be empty.
@warning It means that the job will delete all the records for the given instances.
"""
try:
return self._delete_datasets(instances, records, file_patterns, execution_level,
job_name, allow_empty_instances, allow_empty_records)
except GeocubeError as e: # For Geocube <= 1.0.2
if e.codename == 'UNIMPLEMENTED':
return self._delete_datasets(instances, records, file_patterns, execution_level,
job_name, allow_empty_instances, allow_empty_records, stub=self.admin_stub)
raise
@utils.catch_rpc_error
def _admin_tidy(self, aois: bool, records: bool, variables: bool, instances: bool,
containers: bool, consolidation_params: bool, simulate: bool):
res = self.admin_stub.TidyDB(admin_pb2.TidyDBRequest(
PendingAOIs=aois, PendingRecords=records, PendingVariables=variables, PendingInstances=instances,
PendingContainers=containers, PendingParams=consolidation_params, Simulate=simulate
))
if simulate:
print("Simulation:")
print("{} aois deleted\n"
"{} records deleted\n"
"{} variables deleted\n"
"{} instances deleted\n"
"{} containers deleted\n"
.format(res.NbAOIs, res.NbRecords, res.NbVariables, res.NbInstances, res.NbContainers))
@utils.catch_rpc_error
def _admin_update_datasets(self, instance: Union[str, entities.VariableInstance],
records: List[Union[str, entities.Record]],
dformat: Union[Dict, Tuple, str], min_out: float, max_out: float,
exponent: float, simulate: bool):
res = self.admin_stub.UpdateDatasets(admin_pb2.UpdateDatasetsRequest(
simulate=simulate, instance_id=entities.get_id(instance),
record_ids=entities.get_ids(records),
dformat=entities.DataFormat.from_user(dformat).to_pb(),
real_min_value=min_out, real_max_value=max_out, exponent=exponent))
if simulate:
print("Simulation:")
for r, count in res.results.items():
print("{} : {}\n".format(r, count))
|