HTML5 SQLError
Errors in the asynchronous database API are reported using callbacks that have a SQLError object as one of their arguments.
Supported Platform(s)
- BlackBerry OS 5.0+
- BlackBerry PlayBook
- Ripple Emulator
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple | 
|---|---|---|---|---|---|
| code | Y | Y | Y | Y | Y | 
| message | Y | Y | Y | Y | Y | 
| UNKNOWN_ERR | Y | Y | Y | Y | Y | 
| DATABASE_ERR | Y | Y | Y | Y | Y | 
| VERSION_ERR | Y | Y | Y | Y | Y | 
| TOO_LARGE_ERR | Y | Y | Y | Y | Y | 
| QUOTA_ERR | Y | Y | Y | Y | Y | 
| SYNTAX_ERR | Y | Y | Y | Y | Y | 
| CONSTRAINT_ERR | Y | Y | Y | Y | Y | 
| TIMEOUT_ERR | Y | Y | Y | Y | Y | 
Configuration Document Settings
To use all of the API described for this object, you must ensure the following settings are in your configuration document:
This API does not require a <feature> element to be declared in the configuration document of your BlackBerry WebWorks Application.| Permission Elements (PlayBook Only) | 
|---|
| This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application. | 
API Summary
Properties:
| Property | Type | Description | Supported Platform(s) | 
|---|---|---|---|
| code | 
                            
                            
                                Number
                            
                            
                                 readonly  | 
                        
                        
                            The most appropriate error code.
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - BlackBerry PlayBook - Ripple Emulator  | 
                    
| message | 
                            
                            
                                String
                            
                            
                                 readonly  | 
                        
                        
                            An error message describing the error encountered. The message should be localized to the user's language.
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - BlackBerry PlayBook - Ripple Emulator  | 
                    
Constants:
| Property | Type | Description | Supported Platform(s) | 
|---|---|---|---|
| UNKNOWN_ERR default: 0 | Number | 
                            The transaction failed for reasons unrelated to the database itself and not covered by any other error code.
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - BlackBerry PlayBook - Ripple Emulator  | 
                    
| DATABASE_ERR default: 1 | Number | 
                            The statement failed for database reasons not covered by any other error code.
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - BlackBerry PlayBook - Ripple Emulator  | 
                    
| VERSION_ERR default: 2 | Number | 
                            The operation failed because the actual database version was not what it should be.
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - BlackBerry PlayBook - Ripple Emulator  | 
                    
| TOO_LARGE_ERR default: 3 | Number | 
                            The statement failed because the data returned from the database was too large. The SQL "LIMIT" modifier might be useful to reduce the size of the result set.
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - BlackBerry PlayBook - Ripple Emulator  | 
                    
| QUOTA_ERR default: 4 | Number | 
                            The statement failed because there was not enough remaining storage space, or the storage quota was reached and the user declined to give more space to the database.
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - BlackBerry PlayBook - Ripple Emulator  | 
                    
| SYNTAX_ERR default: 5 | Number | 
                            The statement failed because of a syntax error, or the number of arguments did not match the number of ? placeholders in the statement, or the statement tried to use a statement that is not allowed, such as BEGIN, COMMIT, or ROLLBACK, or the statement tried to use a verb that could modify the database but the transaction was read-only.
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - BlackBerry PlayBook - Ripple Emulator  | 
                    
| CONSTRAINT_ERR default: 6 | Number | 
                            An INSERT, UPDATE, or REPLACE statement failed due to a constraint failure. For example, because a row was being inserted and the value given for the primary key column duplicated the value of an existing row.
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - BlackBerry PlayBook - Ripple Emulator  | 
                    
| TIMEOUT_ERR default: 7 | Number | 
                            A lock for the transaction could not be obtained in a reasonable time.
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - BlackBerry PlayBook - Ripple Emulator  | 
                    
            
            Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:20 GMT-0500 (EST)