odk/examples/DevelopersGuide/Database/DriverSkeleton/How_to_write_my_own_driver.txt

   1 #
   2 # This file is part of the LibreOffice project.
   3 #
   4 # This Source Code Form is subject to the terms of the Mozilla Public
   5 # License, v. 2.0. If a copy of the MPL was not distributed with this
   6 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7 #
   8 # This file incorporates work covered by the following license notice:
   9 #
  10 #   Licensed to the Apache Software Foundation (ASF) under one or more
  11 #   contributor license agreements. See the NOTICE file distributed
  12 #   with this work for additional information regarding copyright
  13 #   ownership. The ASF licenses this file to you under the Apache
  14 #   License, Version 2.0 (the "License"); you may not use this file
  15 #   except in compliance with the License. You may obtain a copy of
  16 #   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17 #
  18
  19 How to write my own sdbc driver
  20
  21 Pre implementation steps
  22 - search all occurrences of skeleton and replace them to a name which you prefer
  23
  24 1. Implement a class called driver or modify the existing skeleton      -> have a look at SDriver.?xx
  25 2. Implement a class called connection                                  -> have a look at SConnection.?xx
  26 3. Have a look at the DatabaseMetaData                                  -> see SDatabaseMetaData.cxx
  27         The methods which should be implemented at least are
  28                 - getTableTypes
  29                 - getTables
  30                 - getTypeInfo
  31                 - getColumns
  32
  33 4. You need a statement to show/access some data                                -> have a look at SStatement.cxx
  34                                                                                 -> especially executeQuery()
  35
  36 5. The ResultSet: without you see nothing                                       -> look at SResultSet.cxx
  37 6. The ResultSetMetaData needed to get some information about what are waiting for us
  38                                                                                 -> look at SResultSetMetaData.cxx
  39
  40 7. The prepared statement is the last class we have to implement now
  41         -> you have to allow statements like "SELECT * FROM table WHERE id = ?"
  42
  43 8. congratulations you have now implement your own driver :-)