hbase-native-client/README.md

   1 <!---
   2 Licensed to the Apache Software Foundation (ASF) under one
   3 or more contributor license agreements.  See the NOTICE file
   4 distributed with this work for additional information
   5 regarding copyright ownership.  The ASF licenses this file
   6 to you under the Apache License, Version 2.0 (the
   7 "License"); you may not use this file except in compliance
   8 with the License.  You may obtain a copy of the License at
   9
  10   http://www.apache.org/licenses/LICENSE-2.0
  11
  12 Unless required by applicable law or agreed to in writing,
  13 software distributed under the License is distributed on an
  14 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15 KIND, either express or implied.  See the License for the
  16 specific language governing permissions and limitations
  17 under the License.
  18 -->
  19
  20 # hbase-native-client
  21
  22 Native client for HBase 0.96
  23
  24 This is a C  library that implements a
  25 HBase client.  It's thread safe and libEv
  26 based.
  27
  28
  29 ## Design Philosphy
  30
  31 Synchronous and Async versions will both be built
  32 on the same foundation. The core foundation will
  33 be C++.  External users wanting a C library will
  34 have to choose either async or sync.  These
  35 libraries will be thin veneers ontop of the C++.
  36
  37 We should try and follow pthreads example as much
  38 as possible:
  39
  40 * Consistent naming.
  41 * Opaque pointers as types so that binary compat is easy.
  42 * Simple setup when the defaults are good.
  43 * Attr structs when lots of paramters could be needed.
  44
  45
  46 ## Naming
  47 All public C files will start with hbase_*.{h, cc}.  This
  48 is to keep naming conflicts to a minimum. Anything without
  49 the hbase_ prefix is assumed to be implementation private.
  50
  51 All C apis and typedefs will be prefixed with hb_.
  52
  53 All typedefs end with _t.