Skip to content

Commit 0041c18

Browse files
steffnayparthea
andauthored
docs(samples): add entry group greation to custom entry sample (#215)
Co-authored-by: Anthonios Partheniou <[email protected]>
1 parent 6cfd2ec commit 0041c18

File tree

3 files changed

+25
-26
lines changed

3 files changed

+25
-26
lines changed

datacatalog/snippets/conftest.py

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -127,22 +127,3 @@ def random_existing_tag_template_id(client, project_id, resources_to_delete):
127127
)
128128
yield random_tag_template_id
129129
resources_to_delete["templates"].append(random_tag_template.name)
130-
131-
132-
@pytest.fixture
133-
def random_existing_entry_group(
134-
client, project_id, random_entry_group_id, resources_to_delete
135-
):
136-
entry_group_obj = datacatalog_v1.types.EntryGroup()
137-
entry_group_obj.display_name = f"python_sample_{temp_suffix()}"
138-
entry_group_obj.description = "Data Catalog samples test entry group."
139-
140-
entry_group = datacatalog.create_entry_group(
141-
parent=datacatalog_v1.DataCatalogClient.common_location_path(
142-
project_id, LOCATION
143-
),
144-
entry_group_id=random_entry_group_id,
145-
entry_group=entry_group_obj,
146-
)
147-
yield entry_group
148-
resources_to_delete["entry_groups"].append(entry_group.name)

datacatalog/snippets/create_custom_entry.py

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,39 @@ def create_custom_entry(override_values):
2121

2222
# Google Cloud Platform project.
2323
project_id = "my-project"
24-
# Entry group to be created.
25-
# For sample code demonstrating entry group creation, see quickstart:
26-
# https://cloud.google.com/data-catalog/docs/quickstart-tagging
27-
entry_group_name = "my_existing_entry_group"
24+
# Entry Group to be created.
25+
entry_group_id = "my_new_entry_group_id"
2826
# Entry to be created.
2927
entry_id = "my_new_entry_id"
28+
# Currently, Data Catalog stores metadata in the us-central1 region.
29+
location = "us-central1"
3030

3131
# [END data_catalog_create_custom_entry]
3232

3333
# To facilitate testing, we replace values with alternatives
3434
# provided by the testing harness.
3535
project_id = override_values.get("project_id", project_id)
36-
entry_group_name = override_values.get("entry_group_name", entry_group_name)
3736
entry_id = override_values.get("entry_id", entry_id)
37+
entry_group_id = override_values.get("entry_group_id", entry_group_id)
3838

3939
# [START data_catalog_create_custom_entry]
4040
datacatalog = datacatalog_v1.DataCatalogClient()
4141

42+
# Create an Entry Group.
43+
entry_group_obj = datacatalog_v1.types.EntryGroup()
44+
entry_group_obj.display_name = "My awesome Entry Group"
45+
entry_group_obj.description = "This Entry Group represents an external system"
46+
47+
entry_group = datacatalog.create_entry_group(
48+
parent=datacatalog_v1.DataCatalogClient.common_location_path(
49+
project_id, location
50+
),
51+
entry_group_id=entry_group_id,
52+
entry_group=entry_group_obj,
53+
)
54+
entry_group_name = entry_group.name
55+
print("Created entry group: {}".format(entry_group_name))
56+
4257
# Create an Entry.
4358
entry = datacatalog_v1.types.Entry()
4459
entry.user_specified_system = "onprem_data_system"

datacatalog/snippets/create_custom_entry_test.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,24 @@ def test_create_custom_entry(
1919
capsys,
2020
client,
2121
project_id,
22-
random_existing_entry_group,
2322
random_entry_group_id,
2423
random_entry_id,
2524
resources_to_delete,
2625
):
2726
location = "us-central1"
2827
override_values = {
2928
"project_id": project_id,
30-
"entry_group_name": random_existing_entry_group.name,
3129
"entry_id": random_entry_id,
30+
"entry_group_id": random_entry_group_id,
3231
}
32+
expected_entry_group = client.entry_group_path(
33+
project_id, location, random_entry_group_id
34+
)
3335
expected_entry = client.entry_path(
3436
project_id, location, random_entry_group_id, random_entry_id
3537
)
3638
create_custom_entry.create_custom_entry(override_values)
3739
out, err = capsys.readouterr()
40+
assert f"Created entry group: {expected_entry_group}" in out
3841
assert f"Created entry: {expected_entry}" in out
3942
resources_to_delete["entries"].append(expected_entry)

0 commit comments

Comments
 (0)