steampipe plugin install github

Table: github_rate_limit_graphql - Query GitHub GraphQL API Rate Limits using SQL

GitHub's GraphQL API Rate Limiting is a feature that prevents excessive use of the API by limiting the number of requests that can be made within a certain time frame. This feature helps ensure fair usage and prevents any single user from monopolizing the API resources. It provides a mechanism to monitor and manage the rate at which applications can access the API.

Table Usage Guide

The github_rate_limit_graphql table provides insights into the rate limiting status for GitHub's GraphQL API. As a developer or DevOps engineer, you can use this table to monitor the current rate limit status of your application's API usage. This can be particularly useful in managing and optimizing your application's API requests to ensure they stay within the allowed limits.

Examples

List rate limit info for GraphQL

Assess the usage and availability of your GraphQL rate limit on GitHub to manage your API requests effectively and avoid exceeding the limit. This helps in planning your application's interactions with GitHub's API and ensures uninterrupted service.

select
used,
remaining,
reset_at
from
github_rate_limit_graphql;
select
used,
remaining,
reset_at
from
github_rate_limit_graphql;

Schema for github_rate_limit_graphql

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
costbigintNumber of points used to return this query.
limitbigintMaximum number of points used that can be used in current allocation.
node_countbigintNumber of nodes returned by this query.
remainingbigintNumber of points remaining in current allocation.
reset_attimestamp with time zoneTimestamp when the allocation resets.
usedbigintNumber of points used from current allocation.

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_rate_limit_graphql