ovsdb/table.h

   1 /* Copyright (c) 2009, 2010, 2011 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     bool mutable;
  31     struct shash columns;       /* Contains "struct ovsdb_column *"s. */
  32     unsigned int max_rows;      /* Maximum number of rows. */
  33     bool is_root;               /* Part of garbage collection root set? */
  34 };
  35
  36 struct ovsdb_table_schema *ovsdb_table_schema_create(
  37     const char *name, bool mutable, unsigned int max_rows, bool is_root);
  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                                         bool default_is_root);
  48
  49 const struct ovsdb_column *ovsdb_table_schema_get_column(
  50     const struct ovsdb_table_schema *, const char *name);
  51 \f
  52 /* Database table. */
  53
  54 struct ovsdb_table {
  55     struct ovsdb_table_schema *schema;
  56     struct ovsdb_txn_table *txn_table; /* Only if table is in a transaction. */
  57     struct hmap rows;           /* Contains "struct ovsdb_row"s. */
  58 };
  59
  60 struct ovsdb_table *ovsdb_table_create(struct ovsdb_table_schema *);
  61 void ovsdb_table_destroy(struct ovsdb_table *);
  62
  63 const struct ovsdb_row *ovsdb_table_get_row(const struct ovsdb_table *,
  64                                             const struct uuid *);
  65
  66 #endif /* ovsdb/table.h */