Delete a family
Stay organized with collections
Save and categorize content based on your preferences.
Delete a column family.
Code sample
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],[],[[["\u003cp\u003eThis content demonstrates how to delete a column family in Bigtable using various programming languages, including C++, C#, Java, Node.js, PHP, Python, and Ruby.\u003c/p\u003e\n"],["\u003cp\u003eThe code examples provide a practical implementation of the \u003ccode\u003eModifyColumnFamilies\u003c/code\u003e method to remove a specified column family.\u003c/p\u003e\n"],["\u003cp\u003eEach code sample requires the use of Bigtable client libraries and setting up Application Default Credentials for authentication.\u003c/p\u003e\n"],["\u003cp\u003eThe samples show that you first create a Modification request to drop the Column Family, then use the ModifyColumnFamilies method with that request.\u003c/p\u003e\n"],["\u003cp\u003eThe content directs the user to the Google Cloud sample browser to find other code examples.\u003c/p\u003e\n"]]],[],null,["Delete a column family.\n\nCode sample \n\nC++\n\n\nTo learn how to install and use the client library for Bigtable, see\n[Bigtable client libraries](/bigtable/docs/reference/libraries).\n\n\nTo authenticate to Bigtable, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n namespace cbt = ::google::cloud::bigtable;\n namespace cbta = ::google::cloud::bigtable_admin;\n using ::google::bigtable::admin::v2::ModifyColumnFamiliesRequest;\n using ::google::cloud::StatusOr;\n [](cbta::BigtableTableAdminClient admin, std::string const& project_id,\n std::string const& instance_id, std::string const& table_id,\n std::string const& family_name) {\n std::string table_name = cbt::TableName(project_id, instance_id, table_id);\n\n ModifyColumnFamiliesRequest::Modification mod;\n mod.set_id(family_name);\n mod.set_drop(true);\n\n StatusOr\u003cgoogle::bigtable::admin::v2::Table\u003e schema =\n admin.ModifyColumnFamilies(table_name, {std::move(mod)});\n\n if (!schema) throw std::move(schema).status();\n std::cout \u003c\u003c \"Schema modified to: \" \u003c\u003c schema-\u003eDebugString() \u003c\u003c \"\\n\";\n }\n\nC#\n\n\nTo learn how to install and use the client library for Bigtable, see\n[Bigtable client libraries](/bigtable/docs/reference/libraries).\n\n\nTo authenticate to Bigtable, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n // Delete a column family.\n // Initialize request argument(s).\n GcRule maxVersionsRule = new GcRule { MaxNumVersions = 1 };\n\n TableName tableName = new TableName(projectId, instanceId, tableId);\n\n // Modification to update column family\n ModifyColumnFamiliesRequest.Types.Modification modification = new ModifyColumnFamiliesRequest.Types.Modification\n {\n Drop = true,\n Id = \"cf2\"\n };\n\n ModifyColumnFamiliesRequest request = new ModifyColumnFamiliesRequest\n {\n TableName = tableName,\n Modifications = { modification }\n };\n try\n {\n // Make the request\n Table response = bigtableTableAdminClient.ModifyColumnFamilies(request);\n Console.WriteLine(\"Deleted column family\");\n }\n catch (Exception ex)\n {\n Console.WriteLine($\"Error deleting column family {ex.Message}\");\n }\n\nJava\n\n\nTo learn how to install and use the client library for Bigtable, see\n[Bigtable client libraries](/bigtable/docs/reference/libraries).\n\n\nTo authenticate to Bigtable, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n // Deletes a column family.\n try {\n ModifyColumnFamiliesRequest deleted =\n ModifyColumnFamiliesRequest.of(tableId).dropFamily(COLUMN_FAMILY_2);\n adminClient.modifyFamilies(deleted);\n System.out.printf(\"Column family %s deleted successfully%n\", COLUMN_FAMILY_2);\n } catch (NotFoundException e) {\n System.err.println(\"Failed to delete a non-existent column family: \" + e.getMessage());\n }\n\nNode.js\n\n\nTo learn how to install and use the client library for Bigtable, see\n[Bigtable client libraries](/bigtable/docs/reference/libraries).\n\n\nTo authenticate to Bigtable, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n // Delete a column family\n await family.delete();\n console.log(`${family.id} deleted successfully\\n`);\n\nPHP\n\n\nTo learn how to install and use the client library for Bigtable, see\n[Bigtable client libraries](/bigtable/docs/reference/libraries).\n\n\nTo authenticate to Bigtable, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n use Google\\Cloud\\Bigtable\\Admin\\V2\\Client\\BigtableTableAdminClient;\n use Google\\Cloud\\Bigtable\\Admin\\V2\\ModifyColumnFamiliesRequest;\n use Google\\Cloud\\Bigtable\\Admin\\V2\\ModifyColumnFamiliesRequest\\Modification;\n\n /**\n * Delete a column family in a table\n *\n * @param string $projectId The Google Cloud project ID\n * @param string $instanceId The ID of the Bigtable instance\n * @param string $tableId The ID of the table where the column family needs to be deleted\n * @param string $familyId The ID of the column family to be deleted\n */\n function delete_family(\n string $projectId,\n string $instanceId,\n string $tableId,\n string $familyId = 'cf2'\n ): void {\n $tableAdminClient = new BigtableTableAdminClient();\n $tableName = $tableAdminClient-\u003etableName($projectId, $instanceId, $tableId);\n\n print(\"Delete a column family $familyId...\" . PHP_EOL);\n // Delete a column family\n $columnModification = new Modification();\n $columnModification-\u003esetId($familyId);\n $columnModification-\u003esetDrop(true);\n $modifyColumnFamiliesRequest = (new ModifyColumnFamiliesRequest())\n -\u003esetName($tableName)\n -\u003esetModifications([$columnModification]);\n $tableAdminClient-\u003emodifyColumnFamilies($modifyColumnFamiliesRequest);\n print(\"Column family $familyId deleted successfully.\" . PHP_EOL);\n }\n\nPython\n\n\nTo learn how to install and use the client library for Bigtable, see\n[Bigtable client libraries](/bigtable/docs/reference/libraries).\n\n\nTo authenticate to Bigtable, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n print(\"Delete a column family cf2...\")\n # Delete a column family\n column_family2.delete()\n print(\"Column family cf2 deleted successfully.\")\n\nRuby\n\n\nTo learn how to install and use the client library for Bigtable, see\n[Bigtable client libraries](/bigtable/docs/reference/libraries).\n\n\nTo authenticate to Bigtable, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n column_families = table.column_families do |cfs|\n cfs.delete \"cf2\"\n end\n\nWhat's next\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=bigtable)."]]