yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-11-02 11:49:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): updating links to demo.datahub.com (#13336)

Browse Source
This commit is contained in:
Jay 2025-04-27 21:37:30 -04:00 committed by GitHub
parent 9c718c870e
commit c800ac3131
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -54,7 +54,7 @@ HOSTED_DOCS_ONLY-->
[Features](https://datahubproject.io/docs/) |
[Roadmap](https://feature-requests.datahubproject.io/roadmap) |
[Adoption](#adoption) |
[Demo](https://demo.datahubproject.io/) |
[Demo](https://demo.datahub.com/) |
[Town Hall](https://datahubproject.io/docs/townhalls)
---
@ -82,7 +82,7 @@ Check out DataHub's [Features](docs/features.md) & [Roadmap](https://feature-req
## Demo and Screenshots
There's a [hosted demo environment](https://demo.datahubproject.io/) courtesy of [Acryl Data](https://acryldata.io) where you can explore DataHub without installing it locally.
There's a [hosted demo environment](https://demo.datahub.com/) courtesy of [Acryl Data](https://acryldata.io) where you can explore DataHub without installing it locally.
## Quickstart
@ -93,7 +93,7 @@ Please follow the [DataHub Quickstart Guide](https://datahubproject.io/docs/quic
If you're looking to build & modify datahub please take a look at our [Development Guide](https://datahubproject.io/docs/developers).
<p align="center">
<a href="https://demo.datahubproject.io/">
<a href="https://demo.datahub.com/">
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/entity.png"/>
</a>
</p>

4
datahub-actions/tests/unit/plugin/action/metadata_change_sync/test_metadata_change_sync.py
View File

@ -10,7 +10,7 @@ from tests.unit.test_helpers import pipeline_context
def test_create():
# Create with gms server
MetadataChangeSyncAction.create(
{"gms_server": "https://demo.datahubproject.io/"}, pipeline_context
{"gms_server": "https://demo.datahub.com/"}, pipeline_context
)
# Create with no gms_server
@ -21,7 +21,7 @@ def test_create():
with pytest.raises(ValidationError, match="extra_headers"):
MetadataChangeSyncAction.create(
{
"gms_server": "https://demo.datahubproject.io/",
"gms_server": "https://demo.datahub.com/",
"extra_headers": ["test", "action"],
},
pipeline_context,

4
datahub-actions/tests/unit/utils/test_datahub_util.py
View File

@ -110,7 +110,7 @@ def test_make_datahub_url():
assert (
make_datahub_url(
urn="urn:li:dataset:(urn:li:dataPlatform:snowflake,long_tail_companions.analytics.ShelterDogs,PROD)",
base_url="https://demo.datahubproject.io/",
base_url="https://demo.datahub.com/",
)
== "https://demo.datahubproject.io//dataset/urn:li:dataset:(urn:li:dataPlatform:snowflake,long_tail_companions.analytics.ShelterDogs,PROD)/"
== "https://demo.datahub.com//dataset/urn:li:dataset:(urn:li:dataPlatform:snowflake,long_tail_companions.analytics.ShelterDogs,PROD)/"
)

2
docs-website/docusaurus.config.js
View File

@ -267,7 +267,7 @@ module.exports = {
items: [
{
label: "Demo",
to: "https://demo.datahubproject.io/",
to: "https://demo.datahub.com/",
},
{
label: "Roadmap",

2
docs-website/sidebars.js
View File

@ -24,7 +24,7 @@ module.exports = {
{
type: "link",
label: "Demo",
href: "https://demo.datahubproject.io/",
href: "https://demo.datahub.com/",
},
{
type: "link",

2
docs/api/graphql/how-to-set-up-graphql.md
View File

@ -31,7 +31,7 @@ For **Production**:
DataHub provides a browser-based GraphQL Explorer Tool ([GraphiQL](https://github.com/graphql/graphiql)) for live interaction with the GraphQL API. This tool is available at the path `/api/graphiql` (e.g. `https://my-company.datahub.com/api/graphiql`)
This interface allows you to easily craft queries and mutations against real metadata stored in your live DataHub deployment.
To experiment with GraphiQL before deploying it in your live DataHub deployment, you can access a demo site provided by DataHub at https://demo.datahubproject.io/api/graphiql.
To experiment with GraphiQL before deploying it in your live DataHub deployment, you can access a demo site provided by DataHub at https://demo.datahub.com/api/graphiql.
For instance, you can create a tag by posting the following query:

2
docs/api/restli/get-elastic-task-status.md
View File

@ -3,7 +3,7 @@
You can do a HTTP POST request to `/gms/operations?action=getEsTaskStatus` endpoint to see the status of the input task running in ElasticSearch. For example, the task ID given by the [`truncateTimeseriesAspect` endpoint](./truncate-time-series-aspect.md). The task ID can be passed in as a string with node name and task ID separated by a colon (as is output by the previous API), or the node name and task ID parameters separately.
```
curl --location --request POST 'https://demo.datahubproject.io/api/gms/operations?action=getEsTaskStatus' \
curl --location --request POST 'https://demo.datahub.com/api/gms/operations?action=getEsTaskStatus' \
--header 'Authorization: Bearer TOKEN'
--header 'Content-Type: application/json' \
--data-raw '{

2
docs/api/restli/get-index-sizes.md
View File

@ -3,7 +3,7 @@
You can do a HTTP POST request to `/gms/operations?action=getIndexSizes` endpoint with no parameters to see the size of indices in ElasticSearch. For now, only timeseries indices are supported, as they can grow indefinitely, and the `truncateTimeseriesAspect` endpoint is provided to clean up old entries. This endpoint can be used in conjunction with the cleanup endpoint to see which indices are the largest before truncation.
```
curl --location --request POST 'https://demo.datahubproject.io/api/gms/operations?action=getIndexSizes' \
curl --location --request POST 'https://demo.datahub.com/api/gms/operations?action=getIndexSizes' \
--header 'Authorization: Bearer TOKEN'
```

4
docs/api/restli/restore-indices.md
View File

@ -3,14 +3,14 @@
You can do a HTTP POST request to `/gms/operations?action=restoreIndices` endpoint with the `urn` as part of JSON Payload to restore indices for the particular URN, or with the `urnLike` regex to restore for `batchSize` URNs matching the pattern starting from `start`.
```
curl --location --request POST 'https://demo.datahubproject.io/api/gms/operations?action=restoreIndices' \
curl --location --request POST 'https://demo.datahub.com/api/gms/operations?action=restoreIndices' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"urn": "YOUR_URN"
}'
curl --location --request POST 'https://demo.datahubproject.io/api/gms/operations?action=restoreIndices' \
curl --location --request POST 'https://demo.datahub.com/api/gms/operations?action=restoreIndices' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{

4
docs/api/restli/truncate-time-series-aspect.md
View File

@ -3,7 +3,7 @@
You can do a HTTP POST request to `/gms/operations?action=truncateTimeseriesAspect` endpoint to manage the size of a time series index by removing entries older than a certain timestamp, thereby truncating the table to only the entries needed, to save space. The `getIndexSizes` endpoint can be used to identify the largest indices. The output includes the index parameters needed for this function.
```
curl --location --request POST 'https://demo.datahubproject.io/api/gms/operations?action=truncateTimeseriesAspect' \
curl --location --request POST 'https://demo.datahub.com/api/gms/operations?action=truncateTimeseriesAspect' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
@ -12,7 +12,7 @@ curl --location --request POST 'https://demo.datahubproject.io/api/gms/operation
"endTimeMillis": 1000000000000
}'
curl --location --request POST 'https://demo.datahubproject.io/api/gms/operations?action=truncateTimeseriesAspect' \
curl --location --request POST 'https://demo.datahub.com/api/gms/operations?action=truncateTimeseriesAspect' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{

2
docs/glossary/business-glossary.md
View File

@ -149,7 +149,7 @@ and remove new Terms from the `PII` Classification, e.g. without requiring re-an
## Demo
Check out [our demo site](https://demo.datahubproject.io/glossary) to see an example Glossary and how it works!
Check out [our demo site](https://demo.datahub.com/glossary) to see an example Glossary and how it works!
### GraphQL

26
docs/how/search.md
View File

@ -85,28 +85,28 @@ If you want to:
- Exact match on term or phrase
- `"pet profile"` [Sample results](https://demo.datahubproject.io/search?page=1&query=%22pet%20profile%22)
- `pet profile` [Sample results](https://demo.datahubproject.io/search?page=1&query=pet%20profile)
- `"pet profile"` [Sample results](https://demo.datahub.com/search?page=1&query=%22pet%20profile%22)
- `pet profile` [Sample results](https://demo.datahub.com/search?page=1&query=pet%20profile)
- Enclosing one or more terms with double quotes will enforce exact matching on these terms, preventing further tokenization.
- Exclude terms
- `logging -snowflake` [Sample results](https://demo.datahubproject.io/search?page=1&query=logging%20-snowflake)
- `logging -snowflake` [Sample results](https://demo.datahub.com/search?page=1&query=logging%20-snowflake)
- Results can be excluded by term using `-` to negate the term.
- Term boolean logic with precedence
- `logging + (-snowflake | os_audit_log)` [Sample results](https://demo.datahubproject.io/search?page=1&query=logging%20%2B%20%28-snowflake%20%7C%20os_audit_log%29)
- `logging + (-snowflake | os_audit_log)` [Sample results](https://demo.datahub.com/search?page=1&query=logging%20%2B%20%28-snowflake%20%7C%20os_audit_log%29)
- `(` `)` can be used to set precedence of boolean term expressions
- Find a dataset with the word **mask** in the name:
- `/q name: *mask*` [Sample results](https://demo.datahubproject.io/search?page=1&query=%2Fq%20name%253A%2520%2Amask%2A)
- `/q name: *mask*` [Sample results](https://demo.datahub.com/search?page=1&query=%2Fq%20name%253A%2520%2Amask%2A)
- This will return entities with **mask** in the name. Names tends to be connected by other symbols, hence the wildcard symbols before and after the word.
- Find a dataset with a property, **encoding**
- `/q customProperties: encoding*` [Sample results](https://demo.datahubproject.io/search?page=1&query=%2Fq%20customProperties%3A%20encoding%2A)
- `/q customProperties: encoding*` [Sample results](https://demo.datahub.com/search?page=1&query=%2Fq%20customProperties%3A%20encoding%2A)
- Dataset Properties are indexed in ElasticSearch the manner of key=value. Hence if you know the precise key-value pair, you can search using `"key=value"`. However, if you only know the key, you can use wildcards to replace the value and that is what is being done here.
- Find an entity with an **unversioned** structured property
@ -127,26 +127,26 @@ If you want to:
- Find a dataset with a column name, **latitude**
- `/q fieldPaths: latitude` [Sample results](https://demo.datahubproject.io/search?page=1&query=%2Fq%20fieldPaths%3A%20latitude)
- `/q fieldPaths: latitude` [Sample results](https://demo.datahub.com/search?page=1&query=%2Fq%20fieldPaths%3A%20latitude)
- fieldPaths is the name of the attribute that holds the column name in Datasets.
- Find a dataset with the term **latitude** in the field description
- `/q editedFieldDescriptions: latitude OR fieldDescriptions: latitude` [Sample results](https://demo.datahubproject.io/search?page=1&query=%2Fq%20editedFieldDescriptions%3A%20latitude%20OR%20fieldDescriptions%3A%20latitude)
- `/q editedFieldDescriptions: latitude OR fieldDescriptions: latitude` [Sample results](https://demo.datahub.com/search?page=1&query=%2Fq%20editedFieldDescriptions%3A%20latitude%20OR%20fieldDescriptions%3A%20latitude)
- Datasets has 2 attributes that contains field description. fieldDescription comes from the SchemaMetadata aspect, while editedFieldDescriptions comes from the EditableSchemaMetadata aspect. EditableSchemaMetadata holds information that comes from UI edits, while SchemaMetadata holds data from ingestion of the dataset.
- Find a dataset with the term **logical** in the dataset description
- `/q editedDescription: *logical* OR description: *logical*` [Sample results](https://demo.datahubproject.io/search?page=1&query=%2Fq%20editedDescription%3A%20%2Alogical%2A%20OR%20description%3A%20%2Alogical%2A)
- `/q editedDescription: *logical* OR description: *logical*` [Sample results](https://demo.datahub.com/search?page=1&query=%2Fq%20editedDescription%3A%20%2Alogical%2A%20OR%20description%3A%20%2Alogical%2A)
- Similar to field descriptions, dataset descriptions can be found in 2 aspects, hence the need to search 2 attributes.
- Find a dataset which resides in one of the browsing folders, for instance, the **hive** folder
- `/q browsePaths: *hive*` [Sample results](https://demo.datahubproject.io/search?page=1&query=%2Fq%20browsePaths%3A%20%2Ahive%2A)
- `/q browsePaths: *hive*` [Sample results](https://demo.datahub.com/search?page=1&query=%2Fq%20browsePaths%3A%20%2Ahive%2A)
- BrowsePath is stored as a complete string, for instance `/datasets/prod/hive/SampleKafkaDataset`, hence the need for wildcards on both ends of the term to return a result.
- Find a dataset without the **name** field
- `/q -_exists_:name` [Sample results](https://demo.datahubproject.io/search?filter_entity___false___EQUAL___0=DATASET&page=1&query=%252Fq%2520-_exists_%253Aname&unionType=0)
- `/q -_exists_:name` [Sample results](https://demo.datahub.com/search?filter_entity___false___EQUAL___0=DATASET&page=1&query=%252Fq%2520-_exists_%253Aname&unionType=0)
- the `-` is negating the existence of the field name.
<!--
@ -165,7 +165,7 @@ If you want to:
### GraphQL
- [searchAcrossEntities](https://datahubproject.io/docs/graphql/queries/#searchacrossentities)
- You can try out the API on the demo instance's public GraphQL interface: [here](https://demo.datahubproject.io/api/graphiql)
- You can try out the API on the demo instance's public GraphQL interface: [here](https://demo.datahub.com/api/graphiql)
The same GraphQL API that powers the Search UI can be used
for integrations and programmatic use-cases.
@ -549,7 +549,7 @@ The order of the search results is based on the weight what Datahub gives them b
**Where to find more information?**
The sample queries here are non exhaustive. [The link here](https://demo.datahubproject.io/tag/urn:li:tag:Searchable) shows the current list of indexed fields for each entity inside Datahub. Click on the fields inside each entity and see which field has the tag `Searchable`.
The sample queries here are non exhaustive. [The link here](https://demo.datahub.com/tag/urn:li:tag:Searchable) shows the current list of indexed fields for each entity inside Datahub. Click on the fields inside each entity and see which field has the tag `Searchable`.
However, it does not tell you the specific attribute name to use for specialized searches. One way to do so is to inspect the ElasticSearch indices, for example:
`curl http://localhost:9200/_cat/indices` returns all the ES indices in the ElasticSearch container.

12
docs/modeling/metadata-model.md
View File

@ -80,12 +80,12 @@ To navigate the aspect model for specific entities and explore relationships usi
For example, here are helpful links to the most popular entities in DataHub's metadata model:
- [Dataset](docs/generated/metamodel/entities/dataset.md): [Profile](<https://demo.datahubproject.io/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Dataset,PROD)/Schema?is_lineage_mode=false>) [Documentation](<https://demo.datahubproject.io/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Dataset,PROD)/Documentation?is_lineage_mode=false>)
- [Dashboard](docs/generated/metamodel/entities/dashboard.md): [Profile](<https://demo.datahubproject.io/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Dashboard,PROD)/Schema?is_lineage_mode=false>) [Documentation](<https://demo.datahubproject.io/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Dashboard,PROD)/Documentation?is_lineage_mode=false>)
- [User (a.k.a CorpUser)](docs/generated/metamodel/entities/corpuser.md): [Profile](<https://demo.datahubproject.io/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Corpuser,PROD)/Schema?is_lineage_mode=false>) [Documentation](<https://demo.datahubproject.io/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Corpuser,PROD)/Documentation?is_lineage_mode=false>)
- [Pipeline (a.k.a DataFlow)](docs/generated/metamodel/entities/dataFlow.md): [Profile](<https://demo.datahubproject.io/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,DataFlow,PROD)/Schema?is_lineage_mode=false>) [Documentation](<https://demo.datahubproject.io/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,DataFlow,PROD)/Documentation?is_lineage_mode=false>)
- [Feature Table (a.k.a. MLFeatureTable)](docs/generated/metamodel/entities/mlFeatureTable.md): [Profile](<https://demo.datahubproject.io/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,MlFeatureTable,PROD)/Schema?is_lineage_mode=false>) [Documentation](<https://demo.datahubproject.io/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,MlFeatureTable,PROD)/Documentation?is_lineage_mode=false>)
- For the full list of entities in the metadata model, browse them [here](https://demo.datahubproject.io/browse/dataset/prod/datahub/entities) or use the **Metadata Modeling/Entities** section on the left.
- [Dataset](docs/generated/metamodel/entities/dataset.md): [Profile](<https://demo.datahub.com/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Dataset,PROD)/Schema?is_lineage_mode=false>) [Documentation](<https://demo.datahub.com/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Dataset,PROD)/Documentation?is_lineage_mode=false>)
- [Dashboard](docs/generated/metamodel/entities/dashboard.md): [Profile](<https://demo.datahub.com/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Dashboard,PROD)/Schema?is_lineage_mode=false>) [Documentation](<https://demo.datahub.com/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Dashboard,PROD)/Documentation?is_lineage_mode=false>)
- [User (a.k.a CorpUser)](docs/generated/metamodel/entities/corpuser.md): [Profile](<https://demo.datahub.com/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Corpuser,PROD)/Schema?is_lineage_mode=false>) [Documentation](<https://demo.datahub.com/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,Corpuser,PROD)/Documentation?is_lineage_mode=false>)
- [Pipeline (a.k.a DataFlow)](docs/generated/metamodel/entities/dataFlow.md): [Profile](<https://demo.datahub.com/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,DataFlow,PROD)/Schema?is_lineage_mode=false>) [Documentation](<https://demo.datahub.com/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,DataFlow,PROD)/Documentation?is_lineage_mode=false>)
- [Feature Table (a.k.a. MLFeatureTable)](docs/generated/metamodel/entities/mlFeatureTable.md): [Profile](<https://demo.datahub.com/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,MlFeatureTable,PROD)/Schema?is_lineage_mode=false>) [Documentation](<https://demo.datahub.com/dataset/urn:li:dataset:(urn:li:dataPlatform:datahub,MlFeatureTable,PROD)/Documentation?is_lineage_mode=false>)
- For the full list of entities in the metadata model, browse them [here](https://demo.datahub.com/browse/dataset/prod/datahub/entities) or use the **Metadata Modeling/Entities** section on the left.
### Generating documentation for the Metadata Model

2
docs/schema-history.md
View File

@ -23,7 +23,7 @@ must have the **View Entity Page** privilege, or be assigned to **any** DataHub
You can view the Schema History for a Dataset by navigating to that Dataset's Schema Tab. As long as that Dataset has more than
one version, you can view what a Dataset looked like at any given version by using the version selector.
Here's an example from DataHub's official Demo environment with the
<a href="https://demo.datahubproject.io/dataset/urn:li:dataset:(urn:li:dataPlatform:snowflake,long_tail_companions.adoption.pets,PROD)/Schema?is_lineage_mode=false">Snowflake pets dataset</a>.
<a href="https://demo.datahub.com/dataset/urn:li:dataset:(urn:li:dataPlatform:snowflake,long_tail_companions.adoption.pets,PROD)/Schema?is_lineage_mode=false">Snowflake pets dataset</a>.
<p align="center">
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/schema-history-latest-version.png"/>