All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
as_status.h
Go to the documentation of this file.
1 /*
2  * Copyright 2008-2014 Aerospike, Inc.
3  *
4  * Portions may be licensed to Aerospike, Inc. under one or more contributor
5  * license agreements.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
8  * use this file except in compliance with the License. You may obtain a copy of
9  * the License at http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14  * License for the specific language governing permissions and limitations under
15  * the License.
16  */
17 #pragma once
18 
19 /*******************************************************************************
20  * TYPES
21  ******************************************************************************/
22 
23 /**
24  * Status codes used as return values as as_error.code values.
25  */
26 typedef enum as_status_e {
27 
28  /***************************************************************************
29  * Client Errors
30  **************************************************************************/
31 
32  /**
33  * Invalid client API parameter.
34  */
36 
37  /**
38  * Generic client API usage error.
39  */
41 
42  /**
43  * Deprecated. Generic client error. Keep for legacy reasons.
44  */
46 
47  /***************************************************************************
48  * Success
49  **************************************************************************/
50 
51  /**
52  * Generic success.
53  */
55 
56  /***************************************************************************
57  * Server Errors
58  **************************************************************************/
59 
60  /**
61  * Generic error returned by server.
62  */
64 
65  /**
66  * Record does not exist in database. May be returned by read, or write
67  * with policy AS_POLICY_EXISTS_UPDATE.
68  * @warning AS_POLICY_EXISTS_UPDATE not yet supported.
69  */
71 
72  /**
73  * Generation of record in database does not satisfy write policy.
74  */
76 
77  /**
78  * Request protocol invalid, or invalid protocol field.
79  */
81 
82  /**
83  * Record already exists. May be returned by write with policy
84  * AS_POLICY_EXISTS_CREATE.
85  */
87 
88  /**
89  * Bin already exists.
90  */
92 
93  /**
94  * A cluster state change occurred during the request. This may also be
95  * returned by scan operations with the fail_on_cluster_change flag set.
96  */
98 
99  /**
100  * The server node is running out of memory and/or storage device space
101  * reserved for the specified namespace.
102  */
104 
105  /**
106  * Request timed out. Can be triggered by client or server.
107  */
109 
110  /**
111  * XDR is not available for the cluster.
112  */
114 
115  /**
116  * Generic cluster discovery & connection error.
117  */
119 
120  /**
121  * Bin modification operation can't be done on an existing bin due to its
122  * value type.
123  */
125 
126  /**
127  * Record being (re-)written can't fit in a storage write block.
128  */
130 
131  /**
132  * Too may concurrent requests for one record - a "hot-key" situation.
133  */
135 
136  /**
137  * Scan aborted by user.
138  */
140 
141  /**
142  * Sometimes our doc, or our customers wishes, get ahead of us. We may have
143  * processed something that the server is not ready for (unsupported feature).
144  */
146 
147  /**
148  * Bin-level replace-only supported on server but not on client.
149  */
151 
152  /**
153  * The server node's storage device(s) can't keep up with the write load.
154  */
156 
157  /**
158  * Record key sent with transaction did not match key stored on server.
159  */
161 
162  /**
163  * Namespace in request not found on server.
164  */
166 
167  /**
168  * Sent too-long bin name (should be impossible in this client) or exceeded
169  * namespace's bin name quota.
170  */
172 
173  /**
174  * There are no more records left for query.
175  */
177 
178  /**
179  * Security functionality not supported by connected server.
180  */
182 
183  /**
184  * Security functionality not enabled by connected server.
185  */
187 
188  /**
189  * Security type not supported by connected server.
190  */
192 
193  /**
194  * Administration command is invalid.
195  */
197 
198  /**
199  * Administration field is invalid.
200  */
202 
203  /**
204  * Security protocol not followed.
205  */
207 
208  /**
209  * User name is invalid.
210  */
212 
213  /**
214  * User was previously created.
215  */
217 
218  /**
219  * Password is invalid.
220  */
222 
223  /**
224  * Password has expired.
225  */
227 
228  /**
229  * Forbidden password (e.g. recently used)
230  */
232 
233  /**
234  * Security credential is invalid.
235  */
237 
238  /**
239  * Role name is invalid.
240  */
242 
243  /**
244  * Privilege is invalid.
245  */
247 
248  /**
249  * User must be authentication before performing database operations.
250  */
252 
253  /**
254  * User does not possess the required role to perform the database operation.
255  */
257 
258  /**
259  * Generic UDF error.
260  */
262 
263  /**
264  * The requested item in a large collection was not found.
265  */
267 
268  /**
269  * Index found.
270  */
272 
273  /**
274  * Index not found
275  */
277 
278  /**
279  * Index is out of memory
280  */
282 
283  /**
284  * Unable to read the index.
285  */
287 
288  /**
289  * Generic secondary index error.
290  */
292 
293  /**
294  * Index name is too long.
295  */
297 
298  /**
299  * System already has maximum allowed indices.
300  */
302 
303  /**
304  * Query was aborted.
305  */
307 
308  /**
309  * Query processing queue is full.
310  */
312 
313  /**
314  * Secondary index query timed out on server.
315  */
317 
318  /**
319  * Generic query error.
320  */
322 
323  /***************************************************************************
324  * UDF OPERATIONS
325  **************************************************************************/
326 
327  /**
328  * UDF does not exist.
329  */
331  /**
332  * LUA file does not exist.
333  */
335 
336  /***************************************************************************
337  * Large Data Type (LDT) OPERATIONS
338  **************************************************************************/
339 
340  /** Internal LDT error. */
342 
343  /** LDT item not found */
345 
346  /** Unique key violation: Duplicated item inserted when 'unique key" was set.*/
348 
349  /** General error during insert operation. */
351 
352  /** General error during search operation. */
354 
355  /** General error during delete operation. */
357 
358 
359  /** General input parameter error. */
361 
362  // -------------------------------------------------
363 
364  /** LDT Type mismatch for this bin. */
366 
367  /** The supplied LDT bin name is null. */
369 
370  /** The supplied LDT bin name must be a string. */
372 
373  /** The supplied LDT bin name exceeded the 14 char limit. */
375 
376  /** Internal Error: too many open records at one time. */
378 
379  /** Internal Error: Top Record not found. */
381 
382  /** Internal Error: Sub Record not found. */
384 
385  /** LDT Bin does not exist. */
387 
388  /** Collision: LDT Bin already exists. */
390 
391  /** LDT control structures in the Top Record are damaged. Cannot proceed. */
393 
394  // -------------------------------------------------
395 
396  /** Internal Error: LDT Subrecord pool is damaged. */
398 
399  /** LDT control structures in the Sub Record are damaged. Cannot proceed. */
401 
402  /** Error encountered while opening a Sub Record. */
404 
405  /** Error encountered while updating a Sub Record. */
407 
408  /** Error encountered while creating a Sub Record. */
410 
411  /** Error encountered while deleting a Sub Record. */
413 
414  /** Error encountered while closing a Sub Record. */
416 
417  /** Error encountered while updating a TOP Record. */
419 
420  /** Error encountered while creating a TOP Record. */
422 
423  // -------------------------------------------------
424 
425  /** The filter function name was invalid. */
427 
428  /** The filter function was not found. */
430 
431  /** The function to extract the Unique Value from a complex object was invalid. */
433 
434  /** The function to extract the Unique Value from a complex object was not found. */
436 
437  /** The function to transform an object into a binary form was invalid. */
439 
440  /** The function to transform an object into a binary form was not found. */
442 
443  /** The function to untransform an object from binary form to live form was invalid. */
445 
446  /** The function to untransform an object from binary form to live form not found. */
448 
449  /** The UDF user module name for LDT Overrides was invalid */
451 
452  /** The UDF user module name for LDT Overrides was not found */
454 
455 } as_status;
as_status
Definition: as_status.h:26