Skip to content

Commit c9492d1

Browse files
claudespicelukekim
authored andcommitted
fix: Add missing columns and correct parameter list in GitHub connector docs
1 parent 3bf7f1b commit c9492d1

1 file changed

Lines changed: 22 additions & 15 deletions

File tree

  • website/docs/components/data-connectors/github

website/docs/components/data-connectors/github/index.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The GitHub Data Connector enables federated SQL queries on various GitHub resour
1313

1414
### `from`
1515

16-
The `from` field specifies the GitHub resource to query. It supports the following formats:
16+
The `from` field specifies the GitHub resource to query. The owner and repository name are extracted from the path (e.g., `github:github.com/spiceai/spiceai/issues` targets the `spiceai/spiceai` repository). It supports the following formats:
1717

1818
| Format | Description |
1919
| ---------------------------------------------- | --------------------------------------------------------- |
@@ -72,8 +72,6 @@ With GitHub App Installation authentication, the connector's functionality depen
7272
| Parameter Name | Description |
7373
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7474
| `github_query_mode` | Optional. Specifies whether the connector should use the GitHub [search API](https://docs.github.com/en/graphql/reference/queries#search) for improved filter performance. Defaults to `auto`, possible values of `auto` or `search`. |
75-
| `owner` | Required. Specifies the owner of the GitHub repository. |
76-
| `repo` | Required. Specifies the name of the GitHub repository. |
7775

7876
## Advanced Configuration
7977

@@ -174,6 +172,7 @@ datasets:
174172
| ------------ | --------- | ----------- |
175173
| name | Utf8 | YES |
176174
| path | Utf8 | YES |
175+
| ref | Utf8 | NO |
177176
| size | Int64 | YES |
178177
| sha | Utf8 | YES |
179178
| mode | Utf8 | YES |
@@ -315,6 +314,7 @@ datasets:
315314
| reviews_count | Int64 | YES |
316315
| state | Utf8 | YES |
317316
| title | Utf8 | YES |
317+
| updated_at | Timestamp | YES |
318318
| url | Utf8 | YES |
319319

320320
**Note**: The `discussion` and `review_comments` columns are only included in the schema when the `github_include_comments` parameter is set accordingly.
@@ -414,18 +414,25 @@ datasets:
414414

415415
#### Schema
416416

417-
| Column Name | Data Type | Is Nullable |
418-
| ----------------- | --------- | ----------- |
419-
| additions | Int64 | YES |
420-
| author_email | Utf8 | YES |
421-
| author_name | Utf8 | YES |
422-
| committed_date | Timestamp | YES |
423-
| deletions | Int64 | YES |
424-
| id | Utf8 | YES |
425-
| message | Utf8 | YES |
426-
| message_body | Utf8 | YES |
427-
| message_head_line | Utf8 | YES |
428-
| sha | Utf8 | YES |
417+
| Column Name | Data Type | Is Nullable |
418+
| ------------------------------ | --------- | ----------- |
419+
| additions | Int64 | YES |
420+
| associated_pull_request_number | Int64 | YES |
421+
| author_email | Utf8 | YES |
422+
| author_name | Utf8 | YES |
423+
| changed_files | Int64 | YES |
424+
| committed_date | Timestamp | YES |
425+
| committer_date | Timestamp | YES |
426+
| committer_email | Utf8 | YES |
427+
| committer_name | Utf8 | YES |
428+
| deletions | Int64 | YES |
429+
| id | Utf8 | YES |
430+
| message | Utf8 | YES |
431+
| message_body | Utf8 | YES |
432+
| message_head_line | Utf8 | YES |
433+
| ref | Utf8 | YES |
434+
| sha | Utf8 | YES |
435+
| status | Utf8 | YES |
429436

430437
#### Example
431438

0 commit comments

Comments
 (0)