Skip to content

Commit

Permalink
Update to building blocks documentation (#241)
Browse files Browse the repository at this point in the history
* fix graph comment

* update to blocks documentation

* Added moviestream login to block

* ECPU update

* minor update to images for ECPUs

* Updates due to ADB UX chages

* minor change to always free text

* Blocks changes due to ux updates

* lint checker fix for an image alt

* OCPU to ECPU in variable file

* fixed an old image

* update to building blocks doc.

---------

Co-authored-by: Kevin Lazarz <[email protected]>
  • Loading branch information
martygubar and klazarz authored Mar 5, 2024
1 parent 092ef6e commit ae16c9a
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 1 deletion.
66 changes: 66 additions & 0 deletions building-blocks/how-to-author-with-blocks/adb.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
# Tasks for OCI Service: ADB
## Delete your workshop resources
**Markdown file location:**
```
/common/building-blocks/tasks/adb/cleanup.md
```

**Add to your manifest.json:**
```
"include": {
"adb-cleanup.md":"/common/building-blocks/tasks/adb/cleanup.md"
}
```

**Add to your workshop markdown:**
```
[]&lpar;include:adb-cleanup.md)
```

**Markdown Output &#8595;&#8595;:**

[](include:adb-cleanup.md)

## Connect with SQL Worksheet
**Markdown file location:**
```
Expand All @@ -21,6 +43,28 @@

[](include:adb-connect-with-sql-worksheet-body.md)

## Connect with SQL Worksheet as non-admin user
**Markdown file location:**
```
/common/building-blocks/tasks/adb/connect-with-sql-worksheet-non-admin.md
```

**Add to your manifest.json:**
```
"include": {
"adb-connect-with-sql-worksheet-non-admin.md":"/common/building-blocks/tasks/adb/connect-with-sql-worksheet-non-admin.md"
}
```

**Add to your workshop markdown:**
```
[]&lpar;include:adb-connect-with-sql-worksheet-non-admin.md)
```

**Markdown Output &#8595;&#8595;:**

[](include:adb-connect-with-sql-worksheet-non-admin.md)

## Create Graph
**Markdown file location:**
```
Expand Down Expand Up @@ -87,6 +131,28 @@

[](include:adb-create-user.md)

## Generate an RSA key pair
**Markdown file location:**
```
/common/building-blocks/tasks/adb/generate-rsa-key-pair.md
```

**Add to your manifest.json:**
```
"include": {
"adb-generate-rsa-key-pair.md":"/common/building-blocks/tasks/adb/generate-rsa-key-pair.md"
}
```

**Add to your workshop markdown:**
```
[]&lpar;include:adb-generate-rsa-key-pair.md)
```

**Markdown Output &#8595;&#8595;:**

[](include:adb-generate-rsa-key-pair.md)

## Go to Data Load Utility Database Action
**Markdown file location:**
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Building Blocks are exposed to customers. You can use these same blocks in your
| Cloud Service | Block | File | Description |
|---------------| ---- | ---- |------------ |
| setup | [Add Workshop Utilities](/common/building-blocks/workshop/freetier/index.html?lab=add-workshop-utilities) | /common/building-blocks /setup/add-workshop-utilities.md| Utilities for adding data sets and users |
| adb | [Delete your workshop resources](/common/building-blocks/workshop/freetier/index.html?lab=cleanup.md) | /common/building-blocks/blocks/adb/cleanup/cleanup.md | Delete some or all of the resources that you created in the workshop |
| adb | [Connect with SQL Worksheet](/common/building-blocks/workshop/freetier/index.html?lab=connect-sql-worksheet.md) | /common/building-blocks/blocks/adb/connect/connect-sql-worksheet.md | Connect to Autonomous Database using the SQL Worksheet in Database Actions |
| adb | [Load and Analyze Data from REST Services](/common/building-blocks/workshop/freetier/index.html?lab=load-analyze-rest.md) | /common/building-blocks/blocks/adb/load-analyze-rest/load-analyze-rest.md | Analyze data sourced from REST services. Using the News API as an example.<ul><li>Create an Account on newsapi.org</li><li>Create a PLSQL function that retrieves news for actors</li><li>Perform a sentiment analysis on the article descriptions</li><li>Find which actors are generating buzz - both good and bad</li></ul> |
| adb | [Use Database Actions Data Loading for Object Store data](/common/building-blocks/workshop/freetier/index.html?lab=load-data-tools.md) | /common/building-blocks/blocks/adb/load-data/load-data-tools.md | Use the Database Actions tooling to easily load data from object storage. |
Expand All @@ -22,18 +23,21 @@ Building Blocks are exposed to customers. You can use these same blocks in your
Listed below are the tasks that you can incorporate into your markdown. You can also use the navigation tree on the left to view the tasks. Again, contribute to the list of tasks!
| Cloud Service | Task | File | Description |
|---------------| ---- | ---- |------------ |
| adb | [Delete your workshop resources](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#Deleteyourworkshopresources) | /common/building-blocks/tasks/adb/cleanup.md | Delete some or all of the resources that you created in the workshop |
| adb | [Connect with SQL Worksheet](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#ConnectwithSQLWorksheet) | /common/building-blocks/tasks/adb/connect-with-sql-worksheet-body.md | Connect to Autonomous Database using the SQL Worksheet in Database Actions |
| adb | [Connect with SQL Worksheet as non-admin user](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#ConnectwithSQLWorksheetasnonadminuser) | /common/building-blocks/tasks/adb/connect-with-sql-worksheet-non-admin.md | Connect to Autonomous Database using the SQL Worksheet in Database Actions. Non-admin user. |
| adb | [Create Graph](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#CreateGraph) | /common/building-blocks/tasks/adb/create-graph.md | Create a bipartite Graph for MOVIESTREAM watched movies. |
| adb | [Create and load JSON Collection from object storage](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#CreateandloadJSONCollectionfromobjectstorage) | /common/building-blocks/tasks/adb/create-load-json-collection.md | <ul><li>Loads data using DBMS&lowbar;CLOUD.COPY&lowbar;COLLECTION</li><li>Introduces JSON&lowbar;SERIALIZE, JSON&lowbar;VALUE and JSON&lowbar;QUERY (minimal)</li><li>Creates a view over JSON data</li><li>Performs basic JSON queries</li></ul> |
| adb | [Create ADB User using Database Actions](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#CreateADBUserusingDatabaseActions) | /common/building-blocks/tasks/adb/create-user.md | Creates an ADB user using the new user database action |
| adb | [Generate an RSA key pair](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#GenerateanRSAkeypair) | /common/building-blocks/tasks/adb/generate-rsa-key-pair.md | Generate an RSA key pair and get the key's values and fingerprint |
| adb | [Go to Data Load Utility Database Action](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#GotoDataLoadUtilityDatabaseAction) | /common/building-blocks/tasks/adb/goto-data-load-utility.md | Navigate to data loader. AUTHORS: For expediency, this task uses the ADMIN user/password to open Database Actions. In your workshop, you might want to substitute a different user/password to open Database Actions. |
| adb | [Go to Graph Studio](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#GotoGraphStudio) | /common/building-blocks/tasks/adb/goto-graph-studio.md | Login to Graph Studio from the Autonomous Database OCI console |
| adb | [Go to Autonomous Database Service](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#GotoAutonomousDatabaseService) | /common/building-blocks/tasks/adb/goto-service-body.md | Navigate to ADB using the OCI menu. AUTHORS: For expediency, this task uses the ADMIN user/password to open Database Actions. In your workshop, you might want to substitute a different user/password to open Database Actions. |
| adb | [Go to SQL Worksheet in Database Actions](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#GotoSQLWorksheetinDatabaseActions) | /common/building-blocks/tasks/adb/goto-sql-worksheet.md | Navigate to SQL Worksheet from the OCI service console. |
| adb | [Load data from public buckets using Database Actions](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#LoaddatafrompublicbucketsusingDatabaseActions) | /common/building-blocks/tasks/adb/load-public-db-actions-15-min-quickstart.md | Uses Database Actions to load data from public object storage buckets. It loads the following two tables:<ul><li>customer</li><li>sales&lowbar;sample</li></ul> |
| adb | [Load data from public buckets using Database Actions. Sales data not included.](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#LoaddatafrompublicbucketsusingDatabaseActionsSalesdatanotincluded) | /common/building-blocks/tasks/adb/load-public-db-actions-no-sales.md | Uses Database Actions to load data from public object storage buckets. It loads the following tables:<ul><li>customer&lowbar;contact</li><li>genre</li><li>pizza location</li></ul><p>To load sales&lowbar;sample, use task **Load data from public buckets using Database Actions** |
| adb | [Load data from public buckets using Database Actions](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#LoaddatafrompublicbucketsusingDatabaseActions) | /common/building-blocks/tasks/adb/load-public-db-actions.md | Uses Database Actions to load data from public object storage buckets. It loads the following tables:<ul><li>customer&lowbar;contact</li><li>sales&lowbar;sample</li><li>genre</li><li>pizza location</li></ul> |
| adb | [Provision Autonomous Database](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#ProvisionAutonomousDatabase) | /common/building-blocks/tasks/adb/provision-body.md | Provision an ADB. Use the `variables.json` file to update provisioning parameters, including database name, OCPUs, storage and more. |
| adb | [Provision Autonomous Database](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#ProvisionAutonomousDatabase) | /common/building-blocks/tasks/adb/provision-body.md | Provision an ADB. Use the `variables.json` file to update provisioning parameters, including database name, ECPUs, storage and more. |
| adb | [Query JSON arrays](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#QueryJSONarrays) | /common/building-blocks/tasks/adb/query-json-arrays.md | Use JSON&lowbar;TABLE to convert arrays into rows. |
| adb | [Query simple JSON attributes](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#QuerysimpleJSONattributes) | /common/building-blocks/tasks/adb/query-json-simple.md | Use dot notation and JSON&lowbar;VALUE to query JSON documents. Creates a view to simplify subsequent access. |
| adb | [Query Object Storage contents with SQL](/common/building-blocks/how-to-author-with-blocks/workshop/index.html?lab=adb#QueryObjectStoragecontentswithSQL) | /common/building-blocks/tasks/adb/query-object-store-contents-with-sql.md | Use SQL to see listing of object storage files and folders. |
Expand All @@ -57,10 +61,13 @@ The template assumes you copied the default **variables.json** to the same direc
{
"workshoptitle":"LiveLabs Workshop Template",
"include": {
"adb-cleanup.md":"/common/building-blocks/tasks/adb/cleanup.md",
"adb-connect-with-sql-worksheet-body.md":"/common/building-blocks/tasks/adb/connect-with-sql-worksheet-body.md",
"adb-connect-with-sql-worksheet-non-admin.md":"/common/building-blocks/tasks/adb/connect-with-sql-worksheet-non-admin.md",
"adb-create-graph.md":"/common/building-blocks/tasks/adb/create-graph.md",
"adb-create-load-json-collection.md":"/common/building-blocks/tasks/adb/create-load-json-collection.md",
"adb-create-user.md":"/common/building-blocks/tasks/adb/create-user.md",
"adb-generate-rsa-key-pair.md":"/common/building-blocks/tasks/adb/generate-rsa-key-pair.md",
"adb-goto-data-load-utility.md":"/common/building-blocks/tasks/adb/goto-data-load-utility.md",
"adb-goto-graph-studio.md":"/common/building-blocks/tasks/adb/goto-graph-studio.md",
"adb-goto-service-body.md":"/common/building-blocks/tasks/adb/goto-service-body.md",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
{
"workshoptitle":"LiveLabs Building Blocks",
"include": {
"adb-cleanup.md":"/common/building-blocks/tasks/adb/cleanup.md",
"adb-connect-with-sql-worksheet-body.md":"/common/building-blocks/tasks/adb/connect-with-sql-worksheet-body.md",
"adb-connect-with-sql-worksheet-non-admin.md":"/common/building-blocks/tasks/adb/connect-with-sql-worksheet-non-admin.md",
"adb-create-graph.md":"/common/building-blocks/tasks/adb/create-graph.md",
"adb-create-load-json-collection.md":"/common/building-blocks/tasks/adb/create-load-json-collection.md",
"adb-create-user.md":"/common/building-blocks/tasks/adb/create-user.md",
"adb-generate-rsa-key-pair.md":"/common/building-blocks/tasks/adb/generate-rsa-key-pair.md",
"adb-goto-data-load-utility.md":"/common/building-blocks/tasks/adb/goto-data-load-utility.md",
"adb-goto-graph-studio.md":"/common/building-blocks/tasks/adb/goto-graph-studio.md",
"adb-goto-service-body.md":"/common/building-blocks/tasks/adb/goto-service-body.md",
Expand Down
8 changes: 8 additions & 0 deletions building-blocks/workshop/freetier/manifest.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
{
"workshoptitle":"LiveLabs Building Blocks",
"include": {
"adb-cleanup.md":"/common/building-blocks/tasks/adb/cleanup.md",
"adb-connect-with-sql-worksheet-body.md":"/common/building-blocks/tasks/adb/connect-with-sql-worksheet-body.md",
"adb-connect-with-sql-worksheet-non-admin.md":"/common/building-blocks/tasks/adb/connect-with-sql-worksheet-non-admin.md",
"adb-create-graph.md":"/common/building-blocks/tasks/adb/create-graph.md",
"adb-create-load-json-collection.md":"/common/building-blocks/tasks/adb/create-load-json-collection.md",
"adb-create-user.md":"/common/building-blocks/tasks/adb/create-user.md",
"adb-generate-rsa-key-pair.md":"/common/building-blocks/tasks/adb/generate-rsa-key-pair.md",
"adb-goto-data-load-utility.md":"/common/building-blocks/tasks/adb/goto-data-load-utility.md",
"adb-goto-graph-studio.md":"/common/building-blocks/tasks/adb/goto-graph-studio.md",
"adb-goto-service-body.md":"/common/building-blocks/tasks/adb/goto-service-body.md",
Expand Down Expand Up @@ -33,6 +36,11 @@
"title": "Add Workshop Utilities",
"filename": "/common/building-blocks/setup/add-workshop-utilities.md"
},
{
"title": "[adb] Delete your workshop resources",
"type": "freetier",
"filename": "/common/building-blocks/blocks/adb/cleanup/cleanup.md"
},
{
"title": "[adb] Connect with SQL Worksheet",
"type": "freetier",
Expand Down

0 comments on commit ae16c9a

Please sign in to comment.