Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Table PATCH] Merge new table metadata into existing table metadata #314

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions internal/metadata/repository.go
Original file line number Diff line number Diff line change
Expand Up @@ -630,8 +630,9 @@ func (r *Repository) AddTable(ctx context.Context, tx *sql.Tx, table *Table) err
return nil
}

func (r *Repository) UpdateTable(ctx context.Context, tx *sql.Tx, table *Table) error {
metadata, err := json.Marshal(table.metadata)
func (r *Repository) UpdateTable(ctx context.Context, tx *sql.Tx, table *Table, metadata map[string]interface{}) error {
marshalledMetadata, err := json.Marshal(metadata)

if err != nil {
return err
}
Expand All @@ -640,7 +641,7 @@ func (r *Repository) UpdateTable(ctx context.Context, tx *sql.Tx, table *Table)
sql.Named("id", table.ID),
sql.Named("projectID", table.ProjectID),
sql.Named("datasetID", table.DatasetID),
sql.Named("metadata", string(metadata)),
sql.Named("metadata", string(marshalledMetadata)),
); err != nil {
return err
}
Expand Down
13 changes: 12 additions & 1 deletion internal/metadata/table.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"database/sql"
"fmt"
"maps"

"github.com/goccy/go-json"
bigqueryv2 "google.golang.org/api/bigquery/v2"
Expand All @@ -18,7 +19,17 @@ type Table struct {
}

func (t *Table) Update(ctx context.Context, tx *sql.Tx, metadata map[string]interface{}) error {
return t.repo.UpdateTable(ctx, tx, t)
mergedMetadata := map[string]interface{}{}
maps.Copy(mergedMetadata, t.metadata)
for key, value := range metadata {
mergedMetadata[key] = value
}

err := t.repo.UpdateTable(ctx, tx, t, mergedMetadata)
if err == nil {
t.metadata = mergedMetadata
}
return err
}

func (t *Table) Insert(ctx context.Context, tx *sql.Tx) error {
Expand Down
47 changes: 25 additions & 22 deletions server/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -2682,43 +2682,42 @@ func (h *tablesPatchHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
project := projectFromContext(ctx)
dataset := datasetFromContext(ctx)
table := tableFromContext(ctx)
var newTable bigqueryv2.Table
var newTable map[string]interface{}
if err := json.NewDecoder(r.Body).Decode(&newTable); err != nil {
errorResponse(ctx, w, errInvalid(err.Error()))
return
}

if _, found := newTable["schema"]; found {
errorResponse(ctx, w, errInvalid("schema updates unsupported"))
return
}

res, err := h.Handle(ctx, &tablesPatchRequest{
server: server,
project: project,
dataset: dataset,
table: table,
newTable: &newTable,
server: server,
project: project,
dataset: dataset,
table: table,
newTableMetadata: newTable,
})

if err != nil {
errorResponse(ctx, w, errInternalError(err.Error()))
return
}
encodeResponse(ctx, w, res)

}

type tablesPatchRequest struct {
server *Server
project *metadata.Project
dataset *metadata.Dataset
table *metadata.Table
newTable *bigqueryv2.Table
server *Server
project *metadata.Project
dataset *metadata.Dataset
table *metadata.Table
newTableMetadata map[string]interface{}
}

func (h *tablesPatchHandler) Handle(ctx context.Context, r *tablesPatchRequest) (*bigqueryv2.Table, error) {
encodedTableData, err := json.Marshal(r.newTable)
if err != nil {
return nil, err
}
var tableMetadata map[string]interface{}
if err := json.Unmarshal(encodedTableData, &tableMetadata); err != nil {
return nil, err
}

conn, err := r.server.connMgr.Connection(ctx, r.project.ID, r.dataset.ID)
if err != nil {
return nil, err
Expand All @@ -2728,13 +2727,17 @@ func (h *tablesPatchHandler) Handle(ctx context.Context, r *tablesPatchRequest)
return nil, err
}
defer tx.RollbackIfNotCommitted()
if err := r.table.Update(ctx, tx.Tx(), tableMetadata); err != nil {
if err := r.table.Update(ctx, tx.Tx(), r.newTableMetadata); err != nil {
return nil, err
}
if err := tx.Commit(); err != nil {
return nil, err
}
return r.newTable, nil
table, err := r.table.Content()
if err != nil {
return nil, err
}
return table, nil
}

func (h *tablesSetIamPolicyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
Expand Down
64 changes: 64 additions & 0 deletions server/server_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"net/url"
"path/filepath"
"strconv"
"strings"
"testing"
"time"

Expand Down Expand Up @@ -2581,3 +2582,66 @@ func TestInformationSchema(t *testing.T) {
})

}

func TestPatchTable(t *testing.T) {
ctx := context.Background()

const (
projectName = "test"
)

bqServer, err := server.New(server.TempStorage)
if err != nil {
t.Fatal(err)
}
if err := bqServer.SetProject(projectName); err != nil {
t.Fatal(err)
}
if err := bqServer.Load(server.YAMLSource(filepath.Join("testdata", "data.yaml"))); err != nil {
t.Fatal(err)
}

testServer := bqServer.TestServer()
defer func() {
testServer.Close()
bqServer.Stop(ctx)
}()

client, err := bigquery.NewClient(
ctx,
projectName,
option.WithEndpoint(testServer.URL),
option.WithoutAuthentication(),
)
if err != nil {
t.Fatal(err)
}
defer client.Close()
description := "new description!"
metadata, err := client.Dataset("dataset1").Table("table_a").Update(
ctx,
bigquery.TableMetadataToUpdate{
Description: description,
},
"",
)
if err != nil {
t.Fatal(err)
}
if metadata.Description != description {
t.Fatalf("Expected updated description; got [%s]", metadata.Description)
}

metadata, err = client.Dataset("dataset1").Table("table_a").Update(
ctx,
bigquery.TableMetadataToUpdate{
Schema: bigquery.Schema{
{Name: "test_col", Type: bigquery.StringFieldType},
},
},
"",
)
if err == nil || !strings.Contains(err.Error(), "schema updates unsupported") {
t.Fatalf("expected unsupported schema update error; got [%s]", err)
}
}
Loading