Table: github_repository - Query GitHub Repositories using SQL
GitHub is a web-based hosting service for version control using Git. It offers all of the distributed version control and source code management (SCM) functionality of Git, as well as adding its own features. GitHub provides access control and several collaboration features such as bug tracking, feature requests, task management, and wikis for every project.
Table Usage Guide
The github_repository
table provides insights into repositories within GitHub. As a developer or project manager, explore repository-specific details through this table, including owner details, repository names, descriptions, and visibility status. Utilize it to uncover information about repositories, such as those with public or private visibility, the owner of each repository, and the description of what each repository contains.
Important Notes
- You must specify the
full_name
(repository including org/user prefix) column in thewhere
orjoin
clause to query the table. - To list all of your repositories use the
github_my_repository
table instead. Thegithub_my_repository
table will list tables you own, you collaborate on, or that belong to your organizations.
Examples
Get information about a specific repository
Discover the details of a specific GitHub repository, such as its creation date, update history, disk usage, owner, primary language, number of forks, star count, URL, license information, and description. This is beneficial for gaining insights into the repository's overall status, usage, and popularity.
select name, node_id, id, created_at, updated_at, disk_usage, owner_login, primary_language ->> 'name' as language, fork_count, stargazer_count, url, license_info ->> 'spdx_id' as license, descriptionfrom github_repositorywhere full_name = 'postgres/postgres';
select name, node_id, id, created_at, updated_at, disk_usage, owner_login, json_extract(primary_language, '$.name') as language, fork_count, stargazer_count, url, json_extract(license_info, '$.spdx_id') as license, descriptionfrom github_repositorywhere full_name = 'postgres/postgres';
Get your permissions for a specific repository
This query allows you to understand the level of access you have to a particular repository, such as whether you can administer, create projects, subscribe, or update topics. It's useful to ensure you have the correct permissions for your intended actions, helping to avoid unexpected access issues.
select name, your_permission, can_administer, can_create_projects, can_subscribe, can_update_topics, possible_commit_emailsfrom github_repositorywhere full_name = 'turbot/steampipe';
select name, your_permission, can_administer, can_create_projects, can_subscribe, can_update_topics, possible_commit_emailsfrom github_repositorywhere full_name = 'turbot/steampipe';
Schema for github_repository
Name | Type | Operators | Description |
---|---|---|---|
_ctx | jsonb | Steampipe context in JSON form. | |
allow_update_branch | boolean | If true, a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. | |
archived_at | timestamp with time zone | Timestamp when repository was archived. | |
auto_merge_allowed | boolean | If true, auto-merge can be enabled on pull requests in this repository. | |
can_administer | boolean | If true, you can administer this repository. | |
can_create_projects | boolean | If true, you can create projects in this repository. | |
can_subscribe | boolean | If true, you can subscribe to this repository. | |
can_update_topics | boolean | If true, you can update topics on this repository. | |
code_of_conduct | jsonb | The code of conduct for this repository. | |
contact_links | jsonb | List of contact links associated to the repository. | |
created_at | timestamp with time zone | Timestamp when the repository was created. | |
default_branch_ref | jsonb | Default ref information. | |
delete_branch_on_merge | boolean | If true, branches are automatically deleted when merged in this repository. | |
description | text | The description of the repository. | |
disk_usage | bigint | Number of kilobytes this repository occupies on disk. | |
fork_count | bigint | Number of forks there are of this repository in the whole network. | |
forking_allowed | boolean | If true, repository allows forks. | |
full_name | text | = | The full name of the repository, including the owner and repo name. |
funding_links | jsonb | The funding links for this repository. | |
has_discussions_enabled | boolean | If true, the repository has the Discussions feature enabled. | |
has_downloads | boolean | If true, the GitHub Downloads feature is enabled on the repository. | |
has_issues_enabled | boolean | If true, the repository has issues feature enabled. | |
has_pages | boolean | If true, the GitHub Pages feature is enabled on the repository. | |
has_projects_enabled | boolean | If true, the repository has the Projects feature enabled. | |
has_starred | boolean | If true, you have starred this repository. | |
has_vulnerability_alerts_enabled | boolean | If true, vulnerability alerts are enabled for the repository. | |
has_wiki_enabled | boolean | If true, the repository has wiki feature enabled. | |
homepage_url | text | The external URL of the repository if set. | |
hooks | jsonb | The API Hooks URL. | |
id | bigint | The numeric ID of the repository. | |
interaction_ability | jsonb | The interaction ability settings for this repository. | |
is_archived | boolean | If true, the repository is unmaintained (archived). | |
is_blank_issues_enabled | boolean | If true, blank issue creation is allowed. | |
is_disabled | boolean | If true, this repository disabled. | |
is_empty | boolean | If true, this repository is empty. | |
is_fork | boolean | If true, the repository is a fork. | |
is_in_organization | boolean | If true, repository is either owned by an organization, or is a private fork of an organization repository. | |
is_locked | boolean | If true, repository is locked. | |
is_mirror | boolean | If true, the repository is a mirror. | |
is_private | boolean | If true, the repository is private or internal. | |
is_security_policy_enabled | boolean | If true, repository has a security policy. | |
is_template | boolean | If true, the repository is a template that can be used to generate new repositories. | |
is_user_configuration_repository | boolean | If true, this is a user configuration repository. | |
issue_templates | jsonb | A list of issue templates associated to the repository. | |
license_info | jsonb | The license associated with the repository. | |
lock_reason | text | The reason the repository has been locked. | |
login_id | text | =, !=, ~~, ~~*, !~~, !~~* | Unique identifier for the user login. |
merge_commit_allowed | boolean | If true, PRs are merged with a merge commit on this repository. | |
merge_commit_message | text | How the default commit message will be generated when merging a pull request. | |
merge_commit_title | text | How the default commit title will be generated when merging a pull request. | |
mirror_url | text | The repository's original mirror URL. | |
name | text | The name of the repository. | |
name_with_owner | text | The repository's name with owner. | |
network_count | bigint | The number of member repositories in the network. | |
node_id | text | The node ID of the repository. | |
open_graph_image_url | text | The image used to represent this repository in Open Graph data. | |
open_issues_total_count | bigint | Count of issues open on the repository. | |
owner_login | text | Login of the repository owner. | |
possible_commit_emails | jsonb | A list of emails you can commit to this repository with. | |
primary_language | jsonb | The primary language of the repository's code. | |
projects_url | text | The URL listing the repository's projects. | |
pull_request_templates | jsonb | Returns a list of pull request templates associated to the repository. | |
pushed_at | timestamp with time zone | Timestamp when the repository was last pushed to. | |
rebase_merge_allowed | boolean | If true, rebase-merging is enabled on this repository. | |
repository_topics_total_count | bigint | Count of topics associated with the repository. | |
security_policy_url | text | The security policy URL. | |
sp_connection_name | text | =, !=, ~~, ~~*, !~~, !~~* | Steampipe connection name. |
sp_ctx | jsonb | Steampipe context in JSON form. | |
squash_merge_allowed | boolean | If true, squash-merging is enabled on this repository. | |
squash_merge_commit_message | text | How the default commit message will be generated when squash merging a pull request. | |
squash_merge_commit_title | text | How the default commit title will be generated when squash merging a pull request. | |
ssh_url | text | The SSH URL to clone this repository. | |
stargazer_count | bigint | Returns a count of how many stargazers there are on this repository. | |
subscribers_count | bigint | The number of users who have subscribed to the repository. | |
subscription | text | Identifies if the current user is watching, not watching, or ignoring the repository. | |
topics | jsonb | The topics (similar to tags or labels) associated with the repository. | |
updated_at | timestamp with time zone | Timestamp when repository was last updated. | |
url | text | The URL of the repository. | |
uses_custom_open_graph_image | boolean | if true, this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar. | |
visibility | text | Indicates the repository's visibility level. | |
watchers_total_count | bigint | Count of watchers on the repository. | |
web_commit_signoff_required | boolean | If true, contributors are required to sign off on web-based commits in this repository. | |
your_permission | text | Your permission level on the repository. Will return null if authenticated as an GitHub App. |
Export
This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.
You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh
script:
/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- github
You can pass the configuration to the command with the --config
argument:
steampipe_export_github --config '<your_config>' github_repository