This topic describes how to query CSV and JSON objects by using Bucket.SelectObject.
Usage notes
In this topic, the public endpoint of the China (Hangzhou) region is used. If you want to access OSS from other Alibaba Cloud services in the same region as OSS, use an internal endpoint. For more information about OSS regions and endpoints, see Regions, endpoints and open ports.
In this topic, access credentials are obtained from environment variables. For more information about how to configure access credentials, see Configure access credentials.
In this topic, an OSSClient instance is created by using an OSS endpoint. If you want to create an OSSClient instance by using custom domain names or Security Token Service (STS), see Initialization.
To query objects, you must have the oss:GetObject
permission. For more information, see Attach a custom policy to a RAM user.
Only objects in the CSV and JSON formats can be queried by using SelectObject.
Sample code
Query a CSV object
Query a JSON object
The following code provides an example on how to query a CSV object:
package main
import (
"io"
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Error getting credentials: %v", err)
}
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Error creating OSS client: %v", err)
}
bucketName := "examplebucket"
bucket, err := client.Bucket(bucketName)
if err != nil {
log.Fatalf("Error getting bucket: %v", err)
}
objectKey := "exampledir/exampledata.csv"
localCsvFile := "D:\\localpath\\exampledata.csv"
if err := bucket.PutObjectFromFile(objectKey, localCsvFile); err != nil {
log.Fatalf("Error uploading file: %v", err)
}
selectRequest := oss.SelectRequest{
Expression: `select * from ossobject`,
}
body, err := bucket.SelectObject(objectKey, selectRequest)
if err != nil {
log.Fatalf("Error selecting object: %v", err)
}
defer body.Close()
content, err := io.ReadAll(body)
if err != nil {
log.Fatalf("Error reading content: %v", err)
}
log.Printf("Selected content: %s", string(content))
}
The following code provides an example on how to query a JSON object:
package main
import (
"io"
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Error getting credentials: %v", err)
}
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Error creating OSS client: %v", err)
}
bucketName := "examplebucket"
bucket, err := client.Bucket(bucketName)
if err != nil {
log.Fatalf("Error getting bucket: %v", err)
}
objectKey := "exampledir/exampledata.json"
localJsonFile := "D:\\localpath\\exampledata.json"
if err := bucket.PutObjectFromFile(objectKey, localJsonFile); err != nil {
log.Fatalf("Error uploading file: %v", err)
}
selectRequest := oss.SelectRequest{
Expression: `select * from ossobject`,
}
body, err := bucket.SelectObject(objectKey, selectRequest)
if err != nil {
log.Fatalf("Error selecting object: %v", err)
}
defer body.Close()
content, err := io.ReadAll(body)
if err != nil {
log.Fatalf("Error reading content: %v", err)
}
log.Printf("Selected content: %s", string(content))
}
References
For the complete sample code that is used to query objects, visit GitHub.
For more information about the API operation that you can call to query objects, see SelectObject.