[FEAT]: Support for `terraform query`

[SamW94]

Describe the need

Hello!

In Terraform version 1.14 the terraform query command was introduced. This command executes list operations against existing infrastructure and displays the results. The command can optionally generate configuration for importing results into Terraform.

Currently this does not work for GitHub resources defined in the provider presumably because list resources are not supported.

Example import.tfquery.hcl file

list "github_membership" "org_owner" {
    provider = github
    config {
        username = "one-cool-user"
        role     = "admin"
    }
}

terraform query command output

terraform query
╷
│ Error: Invalid list resource
│ 
│   on import.tfquery.hcl line 1, in list "github_membership" "org_owner":
│    1: list "github_membership" "org_owner" {
│ 
│ The provider integrations/github does not support list resource "github_membership".

Is there a plan to implement this functionality? Currently, users will need to use the terraform import command repeatedly. Potentially for thousands of resources if they're trying to import a large GitHub ecosystem to Terraform.

Reference HashiCorp documentation: https://developer.hashicorp.com/terraform/language/v1.14.x/import/bulk

Thanks for the great work!
Sam

SDK Version

No response

API Version

No response

Relevant log output

### Example import.tfquery.hcl file


list "github_membership" "org_owner" {
    provider = github
    config {
        username = "one-cool-user"
        role     = "admin"
    }
}


### `terraform query` command output


terraform query
╷
│ Error: Invalid list resource
│ 
│   on import.tfquery.hcl line 1, in list "github_membership" "org_owner":
│    1: list "github_membership" "org_owner" {
│ 
│ The provider integrations/github does not support list resource "github_membership".

Code of Conduct

• I agree to follow this project's Code of Conduct

[deiga]

Hey @SamW94 👋

Thanks for opening this request!

I agree that it would be cool to add this functionality to the provider. Would you be open to considering contributing a PR?

I haven't investigated the list API of Terraform yet, so I don't know how much work that would be.

Currently, users will need to use the terraform import command repeatedly. Potentially for thousands of resources if they're trying to import a large GitHub ecosystem to Terraform

While I agree that importing can be a hassle currently, at least using data and import blocks you can get an okay-ish workaround, since those support for_each as well!
https://developer.hashicorp.com/terraform/language/block/import

Important to note: We are currently focusing on getting v7.0.0 of the provider published as there are a number of breaking changes we need to make based on library upgrades. So, before that is released, I doubt we will be able to dedicate time to implementing this.

[stevehipwell]

@SamW94 just a FYI that the list RPCs aren't supported by the Terraform Plugin SDK v2, so to support this we'd need to migrate the provider to the Terraform Plugin Framework.

[bbasata]

👋 I work on Terraform providers at HashiCorp and I found this thread after chatting with a teammate about the positive community engagement around the GitHub provider & thinking "GitHub provider + GraphQL API might be a fun candidate for Search" 😃

All to say: I have subscribed to this newsletter 📰

I'll highlight an intentional bit of the design for list: a resource can keep its Create, Read, Update, Delete operations in Plugin SDKv2 and add a new List operation in Plugin Framework. The goal is to make the path simple and incremental for the many providers that have SDKv2 resources.

The prerequisite is: add Framework to the provider, via "combining providers."

If you are considering this, it can be convenient to ship these prerequisite bits in a major release version such as v7.0.0 for the benefit of a longer testing window.