Skip to content

Commit 3db567b

Browse files
kwindaukwindau
authored
chore(metadata-completeness): Add column descriptions (#8233)
* chore(metadata-completeness): Add column descriptions * chore(metadata-completeness): Add column descriptions
1 parent c8c81fc commit 3db567b

File tree

14 files changed

+313
-5
lines changed

14 files changed

+313
-5
lines changed

‎bigquery_etl/schema/global.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,14 @@ fields:
8989
- name: dau
9090
type: INTEGER
9191
description: The number of daily active users.
92+
- name: first_run_date
93+
type: DATE
94+
mode: NULLABLE
95+
description: The date of the first run of the application.
96+
- name: first_seen_date
97+
type: DATE
98+
mode: NULLABLE
99+
description: Date when the server first received a ping from this client.
92100
- name: wau
93101
type: INTEGER
94102
description: The number of weekly active users.

‎sql/moz-fx-data-shared-prod/amo_prod/amo_stats_dau_v2/schema.yaml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
fields:
2+
- mode: NULLABLE
3+
name: submission_date
4+
type: DATE
5+
description: The date when the telemetry ping is received on the server side.
6+
- name: addon_id
7+
type: STRING
8+
mode: NULLABLE
9+
- name: dau
10+
type: INTEGER
11+
mode: NULLABLE
12+
description: The number of daily active users.
13+
- name: dau_by_addon_version
14+
type: RECORD
15+
mode: REPEATED
16+
fields:
17+
- name: key
18+
type: STRING
19+
mode: NULLABLE
20+
- name: value
21+
type: INTEGER
22+
mode: NULLABLE
23+
- name: dau_by_app_version
24+
type: RECORD
25+
mode: REPEATED
26+
fields:
27+
- name: key
28+
type: STRING
29+
mode: NULLABLE
30+
- name: value
31+
type: INTEGER
32+
mode: NULLABLE
33+
- name: dau_by_fenix_build
34+
type: RECORD
35+
mode: REPEATED
36+
fields:
37+
- name: key
38+
type: STRING
39+
mode: NULLABLE
40+
- name: value
41+
type: INTEGER
42+
mode: NULLABLE
43+
- name: dau_by_locale
44+
type: RECORD
45+
mode: REPEATED
46+
fields:
47+
- name: key
48+
type: STRING
49+
mode: NULLABLE
50+
- name: value
51+
type: INTEGER
52+
mode: NULLABLE
53+
- name: dau_by_country
54+
type: RECORD
55+
mode: REPEATED
56+
fields:
57+
- name: key
58+
type: STRING
59+
mode: NULLABLE
60+
- name: value
61+
type: INTEGER
62+
mode: NULLABLE
63+
- name: dau_by_app_os
64+
type: RECORD
65+
mode: REPEATED
66+
fields:
67+
- name: key
68+
type: STRING
69+
mode: NULLABLE
70+
- name: value
71+
type: INTEGER
72+
mode: NULLABLE

‎sql/moz-fx-data-shared-prod/amo_prod/desktop_addons_by_client_v1/schema.yaml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
fields:
2+
- mode: NULLABLE
3+
name: submission_date
4+
type: DATE
5+
description: The date when the telemetry ping is received on the server side.
6+
- name: client_id
7+
type: STRING
8+
mode: NULLABLE
9+
description: A unique identifier (UUID) for the client.
10+
- name: sample_id
11+
type: INTEGER
12+
mode: NULLABLE
13+
description: A number, 0-99, that samples by client_id and allows filtering data
14+
for analysis. It is a pipeline-generated artifact that should match between pings.
15+
- name: app_version
16+
type: STRING
17+
mode: NULLABLE
18+
description: User visible version string (e.g. "1.0.3") for the browser.
19+
- name: country
20+
type: STRING
21+
mode: NULLABLE
22+
description: Name of the country in which the activity took place, as determined
23+
by the IP geolocation.
24+
- name: locale
25+
type: STRING
26+
mode: NULLABLE
27+
description: Set of language- and/or country-based preferences for a user interface.
28+
- name: app_os
29+
type: STRING
30+
mode: NULLABLE
31+
- name: addons
32+
type: RECORD
33+
mode: REPEATED
34+
fields:
35+
- name: id
36+
type: STRING
37+
mode: NULLABLE
38+
- name: version
39+
type: STRING
40+
mode: NULLABLE

‎sql/moz-fx-data-shared-prod/amo_prod/fenix_addons_by_client_v1/schema.yaml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
fields:
2+
- mode: NULLABLE
3+
name: submission_date
4+
type: DATE
5+
description: The date when the telemetry ping is received on the server side.
6+
- name: client_id
7+
type: STRING
8+
mode: NULLABLE
9+
description: A unique identifier (UUID) for the client.
10+
- name: sample_id
11+
type: INTEGER
12+
mode: NULLABLE
13+
description: A number, 0-99, that samples by client_id and allows filtering data
14+
for analysis. It is a pipeline-generated artifact that should match between pings.
15+
- name: app_version
16+
type: STRING
17+
mode: NULLABLE
18+
description: User visible version string (e.g. "1.0.3") for the browser.
19+
- name: country
20+
type: STRING
21+
mode: NULLABLE
22+
description: Name of the country in which the activity took place, as determined
23+
by the IP geolocation.
24+
- name: locale
25+
type: STRING
26+
mode: NULLABLE
27+
description: Set of language- and/or country-based preferences for a user interface.
28+
- name: app_os
29+
type: STRING
30+
mode: NULLABLE
31+
- name: addons
32+
type: RECORD
33+
mode: REPEATED
34+
fields:
35+
- name: addon
36+
type: STRING
37+
mode: NULLABLE
38+
- name: version
39+
type: STRING
40+
mode: NULLABLE

‎sql/moz-fx-data-shared-prod/contextual_services_derived/adm_forecasting_v1/schema.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,16 @@ fields:
55
- mode: NULLABLE
66
name: submission_date
77
type: DATE
8+
description: The date when the telemetry ping is received on the server side.
89
- mode: NULLABLE
910
name: country
1011
type: STRING
12+
description: Name of the country in which the activity took place, as determined by
13+
the IP geolocation.
1114
- mode: NULLABLE
1215
name: device
1316
type: STRING
17+
description: Device Type - e.g. desktop or mobile.
1418
- mode: NULLABLE
1519
name: eligible_share_country
1620
type: FLOAT

‎sql/moz-fx-data-shared-prod/fenix_derived/attributable_clients_v1/schema.yaml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
fields:
2+
- name: submission_date
3+
type: DATE
4+
mode: NULLABLE
5+
description: The date when the telemetry ping is received on the server side.
6+
- name: cohort_date
7+
type: DATE
8+
mode: NULLABLE
9+
- name: sample_id
10+
type: INTEGER
11+
mode: NULLABLE
12+
description: A number, 0-99, that samples by client_id and allows filtering data
13+
for analysis. It is a pipeline-generated artifact that should match between pings.
14+
- name: client_id
15+
type: STRING
16+
mode: NULLABLE
17+
description: A unique identifier (UUID) for the client.
18+
- name: country
19+
type: STRING
20+
mode: NULLABLE
21+
description: Name of the country in which the activity took place, as determined
22+
by the IP geolocation.
23+
- name: adjust_network
24+
type: STRING
25+
mode: NULLABLE
26+
description: The name of the Adjust Network that sourced the installation.
27+
- name: adjust_adgroup
28+
type: STRING
29+
mode: NULLABLE
30+
- name: adjust_campaign
31+
type: STRING
32+
mode: NULLABLE
33+
- name: adjust_creative
34+
type: STRING
35+
mode: NULLABLE
36+
- name: is_new_install
37+
type: BOOLEAN
38+
mode: NULLABLE
39+
- name: is_new_profile
40+
type: BOOLEAN
41+
mode: NULLABLE
42+
- name: searches
43+
type: INTEGER
44+
mode: NULLABLE
45+
- name: searches_with_ads
46+
type: INTEGER
47+
mode: NULLABLE
48+
- name: ad_clicks
49+
type: INTEGER
50+
mode: NULLABLE
51+
- name: activated
52+
type: BOOLEAN
53+
mode: NULLABLE

‎sql/moz-fx-data-shared-prod/fenix_derived/clients_yearly_v1/schema.yaml‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ fields:
1818
- name: first_run_date
1919
type: DATE
2020
mode: NULLABLE
21+
description: The date of the first run of the application.
2122
- name: durations
2223
type: INTEGER
2324
mode: NULLABLE
@@ -41,16 +42,17 @@ fields:
4142
- name: android_sdk_version
4243
type: STRING
4344
mode: NULLABLE
44-
description: The optional Android specific SDK version of the software running on this hardware device.
45+
description: The optional Android specific SDK version of the software running on
46+
this hardware device.
4547
- name: locale
4648
type: STRING
4749
mode: NULLABLE
4850
description: Set of language- and/or country-based preferences for a user interface.
4951
- name: city
5052
type: STRING
5153
mode: NULLABLE
52-
description: Name of the city in which the activity took place, as determined
53-
by the IP geolocation.
54+
description: Name of the city in which the activity took place, as determined by
55+
the IP geolocation.
5456
- name: country
5557
type: STRING
5658
mode: NULLABLE
@@ -69,25 +71,33 @@ fields:
6971
- name: architecture
7072
type: STRING
7173
mode: NULLABLE
74+
description: The architecture of the device, (e.g. "arm", "x86").
7275
- name: device_manufacturer
7376
type: STRING
7477
mode: NULLABLE
78+
description: The manufacturer of the device the application is running on.
7579
- name: device_model
7680
type: STRING
7781
mode: NULLABLE
82+
description: The model of the device the application is running on.
83+
On Android, this is Build.MODEL, the user-visible marketing name, like "Pixel 2 XL".
7884
- name: telemetry_sdk_build
7985
type: STRING
8086
mode: NULLABLE
81-
description: The version of the Glean SDK at the time the ping was collected (e.g. 25.0.0).
87+
description: The version of the Glean SDK at the time the ping was collected (e.g.
88+
25.0.0).
8289
- name: first_seen_date
8390
type: DATE
8491
mode: NULLABLE
92+
description: Date when the server first received a ping from this client.
8593
- name: is_new_profile
8694
type: BOOLEAN
8795
mode: NULLABLE
8896
- name: isp
8997
type: STRING
9098
mode: NULLABLE
99+
description: The name of the internet service provider associated with the client's
100+
IP address.
91101
- name: distribution_id
92102
type: STRING
93103
mode: NULLABLE

‎sql/moz-fx-data-shared-prod/firefox_desktop_derived/baseline_active_users_aggregates_v2/metadata.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ bigquery:
2525
- channel
2626
- country
2727
references: {}
28-
require_column_descriptions: false
28+
require_column_descriptions: true

‎sql/moz-fx-data-shared-prod/firefox_desktop_derived/review_checker_clients_v1/schema.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ fields:
1515
- name: legacy_client_id
1616
type: STRING
1717
mode: NULLABLE
18+
description: A unique identifier (UUID) for the client, based on legacy telemetry data.
1819
- name: client_id
1920
type: STRING
2021
mode: NULLABLE

‎sql/moz-fx-data-shared-prod/mozilla_org_derived/blogs_goals_v1/schema.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,20 @@ fields:
22
- name: date
33
type: DATE
44
mode: NULLABLE
5+
description: Date of the session
56
- name: visit_identifier
67
type: STRING
78
mode: NULLABLE
9+
description: The unique identifier for a visit, a concatenation of visitor ID and visit ID.
810
- name: downloads
911
type: INTEGER
1012
mode: NULLABLE
13+
description: The number of downloads for this session.
1114
- name: social_share
1215
type: INTEGER
1316
mode: NULLABLE
17+
description: The number of social shares for this session.
1418
- name: newsletter_subscription
1519
type: INTEGER
1620
mode: NULLABLE
21+
description: The number of newsletter subscriptions for this session.

0 commit comments

Comments
 (0)