google::cloud::spanner::v1::KeySet Class Reference

The KeySet class is a regular type that represents a collection of Keys. More...

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

Public Member Functions
	KeySet ()=default
	Constructs an empty KeySet. More...
	KeySet (KeySet const &)=default
KeySet &	operator= (KeySet const &)=default
	KeySet (KeySet &&)=default
KeySet &	operator= (KeySet &&)=default
KeySet &	AddKey (Key key)
	Adds the given key to the KeySet. More...
KeySet &	AddRange (KeyBound start, KeyBound end)
	Adds a range of keys defined by the given KeyBounds. More...

Static Public Member Functions
static KeySet	All ()
	Returns a KeySet that represents the set of "All" keys for the index. More...

Friends
Equality
bool	operator== (KeySet const &a, KeySet const &b)
bool	operator!= (KeySet const &a, KeySet const &b)

Detailed Description

The KeySet class is a regular type that represents a collection of Keys.

Users can construct a KeySet instance, then add Keys and ranges of Keys to the set. The caller is responsible for ensuring that all keys in a given KeySet instance contain the same number and types of values.

Users may also optionally construct an instance that represents all keys with KeySet::All().

Example

void DeleteData(google::cloud::spanner::Client client) {
  namespace spanner = ::google::cloud::spanner;

  // Delete each of the albums by individual key, then delete all the singers
  // using a key range.
  auto delete_albums = spanner::DeleteMutationBuilder(
                           "Albums", spanner::KeySet()
                                         .AddKey(spanner::MakeKey(1, 1))
                                         .AddKey(spanner::MakeKey(1, 2))
                                         .AddKey(spanner::MakeKey(2, 1))
                                         .AddKey(spanner::MakeKey(2, 2))
                                         .AddKey(spanner::MakeKey(2, 3)))
                           .Build();
  auto delete_singers =
      spanner::DeleteMutationBuilder(
          "Singers", spanner::KeySet().AddRange(spanner::MakeKeyBoundClosed(1),
                                                spanner::MakeKeyBoundClosed(5)))
          .Build();

  auto commit_result =
      client.Commit(spanner::Mutations{delete_albums, delete_singers});
  if (!commit_result) {
    throw std::runtime_error(commit_result.status().message());
  }
  std::cout << "Delete was successful [spanner_delete_data]\n";
}

Example

void DeleteAll(google::cloud::spanner::Client client) {
  namespace spanner = ::google::cloud::spanner;

  // Delete all the performances, albums and singers.
  auto commit = client.Commit(spanner::Mutations{
      spanner::MakeDeleteMutation("Performances", spanner::KeySet::All()),
      spanner::MakeDeleteMutation("Albums", spanner::KeySet::All()),
      spanner::MakeDeleteMutation("Singers", spanner::KeySet::All()),
  });
  if (!commit) throw std::runtime_error(commit.status().message());
  std::cout << "delete-all was successful\n";
}

Definition at line 158 of file keys.h.

Constructor & Destructor Documentation

KeySet() [1/3]

google::cloud::spanner::v1::KeySet::KeySet ( )

default

Constructs an empty KeySet.

KeySet() [2/3]

google::cloud::spanner::v1::KeySet::KeySet ( KeySet const &  )

default

KeySet() [3/3]

google::cloud::spanner::v1::KeySet::KeySet ( KeySet &&  )

default

Member Function Documentation

AddKey()

KeySet & google::cloud::spanner::v1::KeySet::AddKey

(

Key

key

)

Adds the given key to the KeySet.

Example

void DeleteData(google::cloud::spanner::Client client) {
  namespace spanner = ::google::cloud::spanner;

  // Delete each of the albums by individual key, then delete all the singers
  // using a key range.
  auto delete_albums = spanner::DeleteMutationBuilder(
                           "Albums", spanner::KeySet()
                                         .AddKey(spanner::MakeKey(1, 1))
                                         .AddKey(spanner::MakeKey(1, 2))
                                         .AddKey(spanner::MakeKey(2, 1))
                                         .AddKey(spanner::MakeKey(2, 2))
                                         .AddKey(spanner::MakeKey(2, 3)))
                           .Build();
  auto delete_singers =
      spanner::DeleteMutationBuilder(
          "Singers", spanner::KeySet().AddRange(spanner::MakeKeyBoundClosed(1),
                                                spanner::MakeKeyBoundClosed(5)))
          .Build();

  auto commit_result =
      client.Commit(spanner::Mutations{delete_albums, delete_singers});
  if (!commit_result) {
    throw std::runtime_error(commit_result.status().message());
  }
  std::cout << "Delete was successful [spanner_delete_data]\n";
}

Definition at line 50 of file keys.cc.

AddRange()

KeySet & google::cloud::spanner::v1::KeySet::AddRange	(	KeyBound	start,
		KeyBound	end
	)

Adds a range of keys defined by the given KeyBounds.

Example

void DeleteData(google::cloud::spanner::Client client) {
  namespace spanner = ::google::cloud::spanner;

  // Delete each of the albums by individual key, then delete all the singers
  // using a key range.
  auto delete_albums = spanner::DeleteMutationBuilder(
                           "Albums", spanner::KeySet()
                                         .AddKey(spanner::MakeKey(1, 1))
                                         .AddKey(spanner::MakeKey(1, 2))
                                         .AddKey(spanner::MakeKey(2, 1))
                                         .AddKey(spanner::MakeKey(2, 2))
                                         .AddKey(spanner::MakeKey(2, 3)))
                           .Build();
  auto delete_singers =
      spanner::DeleteMutationBuilder(
          "Singers", spanner::KeySet().AddRange(spanner::MakeKeyBoundClosed(1),
                                                spanner::MakeKeyBoundClosed(5)))
          .Build();

  auto commit_result =
      client.Commit(spanner::Mutations{delete_albums, delete_singers});
  if (!commit_result) {
    throw std::runtime_error(commit_result.status().message());
  }
  std::cout << "Delete was successful [spanner_delete_data]\n";
}

Definition at line 56 of file keys.cc.

All()

static KeySet google::cloud::spanner::v1::KeySet::All ( )

inlinestatic

Returns a KeySet that represents the set of "All" keys for the index.

Example

void DeleteAll(google::cloud::spanner::Client client) {
  namespace spanner = ::google::cloud::spanner;

  // Delete all the performances, albums and singers.
  auto commit = client.Commit(spanner::Mutations{
      spanner::MakeDeleteMutation("Performances", spanner::KeySet::All()),
      spanner::MakeDeleteMutation("Albums", spanner::KeySet::All()),
      spanner::MakeDeleteMutation("Singers", spanner::KeySet::All()),
  });
  if (!commit) throw std::runtime_error(commit.status().message());
  std::cout << "delete-all was successful\n";
}

Definition at line 166 of file keys.h.

operator=() [1/2]

KeySet& google::cloud::spanner::v1::KeySet::operator= ( KeySet const &  )

default

operator=() [2/2]

KeySet& google::cloud::spanner::v1::KeySet::operator= ( KeySet &&  )

default

Friends And Related Function Documentation

operator!=

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

friend

Definition at line 200 of file keys.h.

operator==

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

friend

Definition at line 70 of file keys.cc.