From c83fe2ff1768c87c67f65ddb30dbd0d9d5928f88 Mon Sep 17 00:00:00 2001 From: David Li Date: Tue, 20 Sep 2022 16:15:35 -0400 Subject: [PATCH 1/2] docs(format): fix doxygen syntax --- adbc.h | 99 ++++++++++++++++++++++++++++++---------------------------- 1 file changed, 52 insertions(+), 47 deletions(-) diff --git a/adbc.h b/adbc.h index 9729062f8d..cda53a655e 100644 --- a/adbc.h +++ b/adbc.h @@ -465,50 +465,50 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection, /// /// The result is an Arrow dataset with the following schema: /// -/// Field Name | Field Type -/// -------------------------|----------------------- -/// catalog_name | utf8 -/// catalog_db_schemas | list +/// | Field Name | Field Type | +/// |--------------------------|-------------------------| +/// | catalog_name | utf8 | +/// | catalog_db_schemas | list | /// /// DB_SCHEMA_SCHEMA is a Struct with fields: /// -/// Field Name | Field Type -/// -------------------------|----------------------- -/// db_schema_name | utf8 -/// db_schema_tables | list +/// | Field Name | Field Type | +/// |--------------------------|-------------------------| +/// | db_schema_name | utf8 | +/// | db_schema_tables | list | /// /// TABLE_SCHEMA is a Struct with fields: /// -/// Field Name | Field Type -/// -------------------------|----------------------- -/// table_name | utf8 not null -/// table_type | utf8 not null -/// table_columns | list -/// table_constraints | list +/// | Field Name | Field Type | +/// |--------------------------|-------------------------| +/// | table_name | utf8 not null | +/// | table_type | utf8 not null | +/// | table_columns | list | +/// | table_constraints | list | /// /// COLUMN_SCHEMA is a Struct with fields: /// -/// Field Name | Field Type | Comments -/// -------------------------|-----------------------|--------- -/// column_name | utf8 not null | -/// ordinal_position | int32 | (1) -/// remarks | utf8 | (2) -/// xdbc_data_type | int16 | (3) -/// xdbc_type_name | utf8 | (3) -/// xdbc_column_size | int32 | (3) -/// xdbc_decimal_digits | int16 | (3) -/// xdbc_num_prec_radix | int16 | (3) -/// xdbc_nullable | int16 | (3) -/// xdbc_column_def | utf8 | (3) -/// xdbc_sql_data_type | int16 | (3) -/// xdbc_datetime_sub | int16 | (3) -/// xdbc_char_octet_length | int32 | (3) -/// xdbc_is_nullable | utf8 | (3) -/// xdbc_scope_catalog | utf8 | (3) -/// xdbc_scope_schema | utf8 | (3) -/// xdbc_scope_table | utf8 | (3) -/// xdbc_is_autoincrement | bool | (3) -/// xdbc_is_generatedcolumn | bool | (3) +/// | Field Name | Field Type | Comments | +/// |--------------------------|-------------------------|----------| +/// | column_name | utf8 not null | | +/// | ordinal_position | int32 | (1) | +/// | remarks | utf8 | (2) | +/// | xdbc_data_type | int16 | (3) | +/// | xdbc_type_name | utf8 | (3) | +/// | xdbc_column_size | int32 | (3) | +/// | xdbc_decimal_digits | int16 | (3) | +/// | xdbc_num_prec_radix | int16 | (3) | +/// | xdbc_nullable | int16 | (3) | +/// | xdbc_column_def | utf8 | (3) | +/// | xdbc_sql_data_type | int16 | (3) | +/// | xdbc_datetime_sub | int16 | (3) | +/// | xdbc_char_octet_length | int32 | (3) | +/// | xdbc_is_nullable | utf8 | (3) | +/// | xdbc_scope_catalog | utf8 | (3) | +/// | xdbc_scope_schema | utf8 | (3) | +/// | xdbc_scope_table | utf8 | (3) | +/// | xdbc_is_autoincrement | bool | (3) | +/// | xdbc_is_generatedcolumn | bool | (3) | /// /// 1. The column's ordinal position in the table (starting from 1). /// 2. Database-specific description of the column. @@ -518,12 +518,12 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection, /// /// CONSTRAINT_SCHEMA is a Struct with fields: /// -/// Field Name | Field Type | Comments -/// -------------------------|-----------------------|--------- -/// constraint_name | utf8 | -/// constraint_type | utf8 not null | (1) -/// constraint_column_names | list not null | (2) -/// constraint_column_usage | list | (3) +/// | Field Name | Field Type | Comments | +/// |--------------------------|-------------------------|----------| +/// | constraint_name | utf8 | | +/// | constraint_type | utf8 not null | (1) | +/// | constraint_column_names | list not null | (2) | +/// | constraint_column_usage | list | (3) | /// /// 1. One of 'CHECK', 'FOREIGN KEY', 'PRIMARY KEY', or 'UNIQUE'. /// 2. The columns on the current table that are constrained, in @@ -532,12 +532,12 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection, /// /// USAGE_SCHEMA is a Struct with fields: /// -/// Field Name | Field Type | Comments -/// -------------------------|-----------------------|--------- -/// fk_catalog | utf8 | -/// fk_db_schema | utf8 | -/// fk_table | utf8 not null | -/// fk_column_name | utf8 not null | +/// | Field Name | Field Type | +/// |--------------------------|-------------------------| +/// | fk_catalog | utf8 | +/// | fk_db_schema | utf8 | +/// | fk_table | utf8 not null | +/// | fk_column_name | utf8 not null | /// /// \param[in] connection The database connection. /// \param[in] depth The level of nesting to display. If 0, display @@ -570,10 +570,15 @@ AdbcStatusCode AdbcConnectionGetObjects(struct AdbcConnection* connection, int d struct ArrowArrayStream* out, struct AdbcError* error); +/// \brief Return metadata on catalogs, schemas, tables, and columns. #define ADBC_OBJECT_DEPTH_ALL 0 +/// \brief Return metadata on catalogs only. #define ADBC_OBJECT_DEPTH_CATALOGS 1 +/// \brief Return metadata on catalogs and schemas. #define ADBC_OBJECT_DEPTH_DB_SCHEMAS 2 +/// \brief Return metadata on catalogs, schemas, and tables. #define ADBC_OBJECT_DEPTH_TABLES 3 +/// \brief Return metadata on catalogs, schemas, tables, and columns. #define ADBC_OBJECT_DEPTH_COLUMNS ADBC_OBJECT_DEPTH_ALL /// \brief Get the Arrow schema of a table. From 123ec35e2e11e489465b4eca8f3ce78e9a7357cc Mon Sep 17 00:00:00 2001 From: David Li Date: Tue, 20 Sep 2022 16:20:15 -0400 Subject: [PATCH 2/2] ci: fix the title check regex one more time --- .github/workflows/dev_pr/title_check.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/dev_pr/title_check.js b/.github/workflows/dev_pr/title_check.js index c761990278..fd0cc760d9 100644 --- a/.github/workflows/dev_pr/title_check.js +++ b/.github/workflows/dev_pr/title_check.js @@ -33,7 +33,7 @@ const COMMENT_BODY = ":warning: Please follow the [Conventional Commits format i function matchesCommitFormat(title) { const commitType = `(${COMMIT_TYPES.join('|')})`; - const scope = "\([a-zA-Z0-9_/\\-,]+\)?"; + const scope = "\\([a-zA-Z0-9_/\\-,]+\\)?"; const delimiter = "!?:"; const subject = " .+"; const regexp = new RegExp(`^${commitType}${scope}${delimiter}${subject}$`);