You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-3Lines changed: 11 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -26,22 +26,30 @@ The **UncheckedThrow** class uses type erasure to enable client code to throw ch
26
26
27
27
**DatabaseUtils** provides facilities that enable you to define collections of database queries and stored procedures in an easy-to-execute format.
28
28
29
+
### Query Collections
30
+
29
31
Query collections are defined as Java enumerations that implement the `QueryAPI` interface:
30
32
*`getQueryStr` - Get the query string for this constant. This is the actual query that's sent to the database.
31
33
*`getArgNames` - Get the names of the arguments for this query. This provides diagnostic information if the incorrect number of arguments is specified by the client.
32
34
*`getConnection` - Get the connection string associated with this query. This eliminates the need for the client to provide this information.
33
35
*`getEnum` - Get the enumeration to which this query belongs. This enables `executeQuery(Class, QueryAPI, Object[])` to retrieve the name of the query's enumerated constant for diagnostic messages.
36
+
* ... see the _JavaDoc_ for the `QueryAPI` interface for additional information.
37
+
38
+
### Stored Procedure Collections
34
39
35
40
Store procedure collections are defined as Java enumerations that implement the `SProcAPI` interface:
36
-
*`getSignature` - Get the signature for this stored procedure object. This defines the name of the stored procedure and the modes of its arguments. If the stored procedure accepts varargs, this will also be indicated.
41
+
*`getSignature` - Get the signature for this stored procedure object. This defines the name of the stored procedure and the modes of its arguments. If the stored procedure accepts `varargs`, this will also be indicated (see _JavaDoc_ for details).
37
42
*`getArgTypes` - Get the argument types for this stored procedure object.
38
43
*`getConnection` - Get the connection string associated with this stored procedure. This eliminates the need for the client to provide this information.
39
44
*`getEnum` - Get the enumeration to which this stored procedure belongs. This enables `executeStoredProcedure(Class, SProcAPI, Object[])` to retrieve the name of the stored procedured's enumerated constant for diagnostic messages.
45
+
* ... see the _JavaDoc_ for the `SProcAPI` interface for additional information.
46
+
47
+
### Recommended Implementation Strategy
40
48
41
49
To maximize usability and configurability, we recommend the following implementation strategy:
0 commit comments