summaryrefslogtreecommitdiff
path: root/doc/reference/meta_data.adoc
diff options
context:
space:
mode:
authorJohn Turner <jturner.usa@gmail.com>2025-09-14 00:16:10 -0400
committerJohn Turner <jturner.usa@gmail.com>2025-09-14 00:16:10 -0400
commitefcea3a80da7c4479d5fe168435ecc9fd06bdc72 (patch)
tree5cb0177e17b1b00a177f2e830e809f606334571b /doc/reference/meta_data.adoc
downloadsqlite-kv-bench-efcea3a80da7c4479d5fe168435ecc9fd06bdc72.tar.gz
Squashed 'subprojects/boost-sqlite/' content from commit 3378e35
git-subtree-dir: subprojects/boost-sqlite git-subtree-split: 3378e353705271e569cf4ba15c467b840a39798c
Diffstat (limited to 'doc/reference/meta_data.adoc')
-rw-r--r--doc/reference/meta_data.adoc36
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/reference/meta_data.adoc b/doc/reference/meta_data.adoc
new file mode 100644
index 0000000..6375108
--- /dev/null
+++ b/doc/reference/meta_data.adoc
@@ -0,0 +1,36 @@
+== `sqlite/meta_data.hpp`
+
+The meta_data header provides some meta_data for columns.
+
+[source,cpp,subs=+quotes]
+----
+// The metadata of a column
+struct column_meta_data
+{
+ // Data type fo the column
+ cstring_ref data_type;
+ // Name of default collation sequence
+ cstring_ref collation;
+ // true if column has a NOT NULL constraint
+ bool not_null;
+ // true if column is part of the PRIMARY KEY
+ bool primary_key;
+ // true if column is AUTOINCREMENT
+ bool auto_increment;
+};
+
+// get the meta-data of one colum
+
+column_meta_data table_column_meta_data(connection & conn,
+ cstring_ref db_name, cstring_ref table_name, cstring_ref column_name,
+ system::error_code & ec, error_info &ei);
+column_meta_data table_column_meta_data(connection & conn,
+ cstring_ref table_name, cstring_ref column_name,
+ system::error_code & ec, error_info &ei);
+
+column_meta_data table_column_meta_data(connection & conn,
+ cstring_ref db_name, cstring_ref table_name, cstring_ref column_name);
+column_meta_data table_column_meta_data(connection & conn,
+ cstring_ref table_name, cstring_ref column_name);
+---
+