ovsdb/table.h

   1 /* Copyright (c) 2009, 2010 Nicira Networks
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef OVSDB_TABLE_H
  17 #define OVSDB_TABLE_H 1
  18
  19 #include <stdbool.h>
  20 #include "compiler.h"
  21 #include "hmap.h"
  22 #include "shash.h"
  23
  24 struct json;
  25 struct uuid;
  26
  27 /* Schema for a database table. */
  28 struct ovsdb_table_schema {
  29     char *name;
  30     char *comment;
  31     bool mutable;
  32     struct shash columns;       /* Contains "struct ovsdb_column *"s. */
  33 };
  34
  35 struct ovsdb_table_schema *ovsdb_table_schema_create(const char *name,
  36                                                      const char *comment,
  37                                                      bool mutable);
  38 struct ovsdb_table_schema *ovsdb_table_schema_clone(
  39     const struct ovsdb_table_schema *);
  40 void ovsdb_table_schema_destroy(struct ovsdb_table_schema *);
  41
  42 struct ovsdb_error *ovsdb_table_schema_from_json(const struct json *,
  43                                                  const char *name,
  44                                                  struct ovsdb_table_schema **)
  45     WARN_UNUSED_RESULT;
  46 struct json *ovsdb_table_schema_to_json(const struct ovsdb_table_schema *);
  47
  48 const struct ovsdb_column *ovsdb_table_schema_get_column(
  49     const struct ovsdb_table_schema *, const char *name);
  50 \f
  51 /* Database table. */
  52
  53 struct ovsdb_table {
  54     struct ovsdb_table_schema *schema;
  55     struct ovsdb_txn_table *txn_table; /* Only if table is in a transaction. */
  56     struct hmap rows;           /* Contains "struct ovsdb_row"s. */
  57 };
  58
  59 struct ovsdb_table *ovsdb_table_create(struct ovsdb_table_schema *);
  60 void ovsdb_table_destroy(struct ovsdb_table *);
  61
  62 const struct ovsdb_row *ovsdb_table_get_row(const struct ovsdb_table *,
  63                                             const struct uuid *);
  64 bool ovsdb_table_put_row(struct ovsdb_table *, struct ovsdb_row *);
  65
  66 #endif /* ovsdb/table.h */