google::cloud::spanner::Database Class Reference

This class identifies a Cloud Spanner Database. More...

#include <google/cloud/spanner/database.h>

Public Member Functions
	Database (Instance instance, std::string database_id)
	Constructs a Database object identified by the given instance and database_id. More...
	Database (std::string project_id, std::string instance_id, std::string database_id)
	Constructs a Database object identified by the given IDs. More...
Instance const &	instance () const
	Returns the Instance containing this database. More...
std::string const &	database_id () const
	Returns the Database ID. More...
std::string	FullName () const
	Returns the fully qualified database name as a string of the form: "projects/<project-id>/instances/<instance-id>/databases/<database-id>". More...
Copy and move
	Database (Database const &)=default
Database &	operator= (Database const &)=default
	Database (Database &&)=default
Database &	operator= (Database &&)=default

Friends
std::ostream &	operator<< (std::ostream &, Database const &)
	Output the FullName() format. More...
Equality operators
bool	operator== (Database const &a, Database const &b)
bool	operator!= (Database const &a, Database const &b)

Detailed Description

This class identifies a Cloud Spanner Database.

A Cloud Spanner database is identified by its project_id, instance_id, and database_id.

Note

This class makes no effort to validate the components of the database name. It is the application's responsibility to provide valid project, instance, and database ids. Passing invalid values will not be checked until the database name is used in a RPC to spanner.

For more info about the database_id format, see https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.CreateDatabaseRequest

Constructor & Destructor Documentation

Database() [1/4]

google::cloud::spanner::Database::Database	(	Instance	instance,
		std::string	database_id
	)

Constructs a Database object identified by the given instance and database_id.

Database() [2/4]

google::cloud::spanner::Database::Database	(	std::string	project_id,
		std::string	instance_id,
		std::string	database_id
	)

Constructs a Database object identified by the given IDs.

This is equivalent to first constructing an Instance from the given project_id and instance_id arguments and then calling the Database(Instance, std::string) constructor.

Database() [3/4]

google::cloud::spanner::Database::Database ( Database const &  )

default

Database() [4/4]

google::cloud::spanner::Database::Database ( Database &&  )

default

Member Function Documentation

database_id()

std::string const & google::cloud::spanner::Database::database_id ( ) const

inline

Returns the Database ID.

FullName()

std::string google::cloud::spanner::Database::FullName

(

)

const

Returns the fully qualified database name as a string of the form: "projects/<project-id>/instances/<instance-id>/databases/<database-id>".

instance()

Instance const & google::cloud::spanner::Database::instance ( ) const

inline

Returns the Instance containing this database.

operator=() [1/2]

Database & google::cloud::spanner::Database::operator= ( Database &&  )

default

operator=() [2/2]

Database & google::cloud::spanner::Database::operator= ( Database const &  )

default

Friends And Related Function Documentation

operator!=

bool operator!= ( Database const &  a, Database const &  b  )

friend

operator<<

std::ostream & operator<< ( std::ostream &  , Database const &    )

friend

Output the FullName() format.

operator==

bool operator== ( Database const &  a, Database const &  b  )

friend