Documentation
¶
Overview ¶
Copyright 2024 Google LLC
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2024 Google LLC ¶
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2024 Google LLC ¶
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- func GetOrCreateClient(ctx context.Context) (*database.DatabaseAdminClient, error)
- type AdminClient
- type AdminClientImpl
- func (c *AdminClientImpl) CreateDatabase(ctx context.Context, req *databasepb.CreateDatabaseRequest, ...) (CreateDatabaseOperation, error)
- func (c *AdminClientImpl) DropDatabase(ctx context.Context, req *databasepb.DropDatabaseRequest, ...) error
- func (c *AdminClientImpl) GetDatabase(ctx context.Context, req *databasepb.GetDatabaseRequest, ...) (*databasepb.Database, error)
- func (c *AdminClientImpl) GetDatabaseDdl(ctx context.Context, req *databasepb.GetDatabaseDdlRequest, ...) (*databasepb.GetDatabaseDdlResponse, error)
- func (c *AdminClientImpl) UpdateDatabaseDdl(ctx context.Context, req *databasepb.UpdateDatabaseDdlRequest, ...) (UpdateDatabaseDdlOperation, error)
- type AdminClientMock
- func (acm *AdminClientMock) CreateDatabase(ctx context.Context, req *databasepb.CreateDatabaseRequest, ...) (CreateDatabaseOperation, error)
- func (acm *AdminClientMock) DropDatabase(ctx context.Context, req *databasepb.DropDatabaseRequest, ...) error
- func (acm *AdminClientMock) GetDatabase(ctx context.Context, req *databasepb.GetDatabaseRequest, ...) (*databasepb.Database, error)
- func (acm *AdminClientMock) GetDatabaseDdl(ctx context.Context, req *databasepb.GetDatabaseDdlRequest, ...) (*databasepb.GetDatabaseDdlResponse, error)
- func (acm *AdminClientMock) UpdateDatabaseDdl(ctx context.Context, req *databasepb.UpdateDatabaseDdlRequest, ...) (UpdateDatabaseDdlOperation, error)
- type CreateDatabaseOperation
- type CreateDatabaseOperationImpl
- type CreateDatabaseOperationMock
- type UpdateDatabaseDdlImpl
- type UpdateDatabaseDdlOperation
- type UpdateDatabaseDdlOperationMock
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetOrCreateClient ¶
func GetOrCreateClient(ctx context.Context) (*database.DatabaseAdminClient, error)
Types ¶
type AdminClient ¶
type AdminClient interface { GetDatabase(ctx context.Context, req *databasepb.GetDatabaseRequest, opts ...gax.CallOption) (*databasepb.Database, error) CreateDatabase(ctx context.Context, req *databasepb.CreateDatabaseRequest, opts ...gax.CallOption) (CreateDatabaseOperation, error) UpdateDatabaseDdl(ctx context.Context, req *databasepb.UpdateDatabaseDdlRequest, opts ...gax.CallOption) (UpdateDatabaseDdlOperation, error) GetDatabaseDdl(ctx context.Context, req *databasepb.GetDatabaseDdlRequest, opts ...gax.CallOption) (*databasepb.GetDatabaseDdlResponse, error) DropDatabase(ctx context.Context, req *databasepb.DropDatabaseRequest, opts ...gax.CallOption) error }
Use this interface instead of database.DatabaseAdminClient to support mocking.
type AdminClientImpl ¶
type AdminClientImpl struct {
// contains filtered or unexported fields
}
This implements the AdminClient interface. This is the primary implementation that should be used in all places other than tests.
func NewAdminClientImpl ¶
func NewAdminClientImpl(ctx context.Context) (*AdminClientImpl, error)
func (*AdminClientImpl) CreateDatabase ¶
func (c *AdminClientImpl) CreateDatabase(ctx context.Context, req *databasepb.CreateDatabaseRequest, opts ...gax.CallOption) (CreateDatabaseOperation, error)
func (*AdminClientImpl) DropDatabase ¶
func (c *AdminClientImpl) DropDatabase(ctx context.Context, req *databasepb.DropDatabaseRequest, opts ...gax.CallOption) error
func (*AdminClientImpl) GetDatabase ¶
func (c *AdminClientImpl) GetDatabase(ctx context.Context, req *databasepb.GetDatabaseRequest, opts ...gax.CallOption) (*databasepb.Database, error)
func (*AdminClientImpl) GetDatabaseDdl ¶
func (c *AdminClientImpl) GetDatabaseDdl(ctx context.Context, req *databasepb.GetDatabaseDdlRequest, opts ...gax.CallOption) (*databasepb.GetDatabaseDdlResponse, error)
func (*AdminClientImpl) UpdateDatabaseDdl ¶
func (c *AdminClientImpl) UpdateDatabaseDdl(ctx context.Context, req *databasepb.UpdateDatabaseDdlRequest, opts ...gax.CallOption) (UpdateDatabaseDdlOperation, error)
type AdminClientMock ¶
type AdminClientMock struct { GetDatabaseMock func(ctx context.Context, req *databasepb.GetDatabaseRequest, opts ...gax.CallOption) (*databasepb.Database, error) CreateDatabaseMock func(ctx context.Context, req *databasepb.CreateDatabaseRequest, opts ...gax.CallOption) (CreateDatabaseOperation, error) UpdateDatabaseDdlMock func(ctx context.Context, req *databasepb.UpdateDatabaseDdlRequest, opts ...gax.CallOption) (UpdateDatabaseDdlOperation, error) GetDatabaseDdlMock func(ctx context.Context, req *databasepb.GetDatabaseDdlRequest, opts ...gax.CallOption) (*databasepb.GetDatabaseDdlResponse, error) DropDatabaseMock func(ctx context.Context, req *databasepb.DropDatabaseRequest, opts ...gax.CallOption) error }
Mock that implements the AdminClient interface. Pass in unit tests where AdminClient is an input parameter.
func (*AdminClientMock) CreateDatabase ¶
func (acm *AdminClientMock) CreateDatabase(ctx context.Context, req *databasepb.CreateDatabaseRequest, opts ...gax.CallOption) (CreateDatabaseOperation, error)
func (*AdminClientMock) DropDatabase ¶
func (acm *AdminClientMock) DropDatabase(ctx context.Context, req *databasepb.DropDatabaseRequest, opts ...gax.CallOption) error
func (*AdminClientMock) GetDatabase ¶
func (acm *AdminClientMock) GetDatabase(ctx context.Context, req *databasepb.GetDatabaseRequest, opts ...gax.CallOption) (*databasepb.Database, error)
func (*AdminClientMock) GetDatabaseDdl ¶
func (acm *AdminClientMock) GetDatabaseDdl(ctx context.Context, req *databasepb.GetDatabaseDdlRequest, opts ...gax.CallOption) (*databasepb.GetDatabaseDdlResponse, error)
func (*AdminClientMock) UpdateDatabaseDdl ¶
func (acm *AdminClientMock) UpdateDatabaseDdl(ctx context.Context, req *databasepb.UpdateDatabaseDdlRequest, opts ...gax.CallOption) (UpdateDatabaseDdlOperation, error)
type CreateDatabaseOperation ¶
type CreateDatabaseOperation interface {
Wait(ctx context.Context, opts ...gax.CallOption) (*databasepb.Database, error)
}
Use this interface instead of database.CreateDatabaseOperation to support mocking.
type CreateDatabaseOperationImpl ¶
type CreateDatabaseOperationImpl struct {
// contains filtered or unexported fields
}
This implements the CreateDatabaseOperation interface. This is the primary implementation that should be used in all places other than tests.
func (*CreateDatabaseOperationImpl) Wait ¶
func (c *CreateDatabaseOperationImpl) Wait(ctx context.Context, opts ...gax.CallOption) (*databasepb.Database, error)
type CreateDatabaseOperationMock ¶
type CreateDatabaseOperationMock struct {
WaitMock func(ctx context.Context, opts ...gax.CallOption) (*databasepb.Database, error)
}
Mock that implements the CreateDatabaseOperation interface. Pass in unit tests where CreateDatabaseOperation is an input parameter.
func (*CreateDatabaseOperationMock) Wait ¶
func (dbo *CreateDatabaseOperationMock) Wait(ctx context.Context, opts ...gax.CallOption) (*databasepb.Database, error)
type UpdateDatabaseDdlImpl ¶
type UpdateDatabaseDdlImpl struct {
// contains filtered or unexported fields
}
This implements the UpdateDatabaseDdl interface. This is the primary implementation that should be used in all places other than tests.
type UpdateDatabaseDdlOperation ¶
type UpdateDatabaseDdlOperation interface {
Wait(ctx context.Context, opts ...gax.CallOption) error
}
Use this interface instead of database.UpdateDatabaseDdlOperation to support mocking.
type UpdateDatabaseDdlOperationMock ¶
type UpdateDatabaseDdlOperationMock struct {
WaitMock func(ctx context.Context, opts ...gax.CallOption) error
}
Mock that implements the UpdateDatabaseDdlOperation interface. Pass in unit tests where UpdateDatabaseDdlOperation is an input parameter.