Databricks hackathon/databricks common errors#266
Conversation
matthewberobinson
requested review from
Lsnaathorst1,
cjrace,
laragarbett,
mzayeddfe and
rmbielby
as code owners
Lsnaathorst1
left a comment
Lsnaathorst1
left a comment
There was a problem hiding this comment.
Hi,
Thanks for this - good to have so many errors on there already! I have just done a general review of the page itself so far, but will need to individually look at the errors against our OneNote etc as in the PR description when time :)
| title: "Databricks Common Questions" | ||
| format: html | ||
| --- | ||
|
|
There was a problem hiding this comment.
I think it would be nice to have an intro paragraph to explain the page here, just stating that this page brings together, known issues and fixes for working with Databricks. Then maybe something on if you encounter an issue not covered, considering emailing our team so the guidance can continue to improve
There was a problem hiding this comment.
Maybe also something to explain the organisation as you have in your PR:
_Have added a key issue drop down plus 5 dropdowns partitioning the issues into their most common categories:
Installing
Navigating
Connecting
Using
SQL migration_
| ------------------------------------------------------------------------ | ||
|
|
||
| ::: {.callout-important collapse = "true"} | ||
| Current Issues: |
There was a problem hiding this comment.
This is a nice idea! Can we have something like
'No known current issues' in this box when that is the case?
| @@ -0,0 +1,252 @@ | |||
| --- | |||
| title: "Databricks Common Questions" | |||
There was a problem hiding this comment.
I think for consistency the title (and title in the sidebar) should be in sentence case
There was a problem hiding this comment.
Do we want it to be common questions, or common errors? Or maybe common issues?
|
|
||
| When you download Simba Spark it doesn't necessarily download the data driver, to do this raise an I.T. ticket explaining that you have installed "Simba Spark" but the driver is missing, they will download it from the internet. | ||
|
|
||
| #### Spark |
There was a problem hiding this comment.
Are we missing level 3 headers? I can see you are using level 2 for each of the drop down box headings but then think only level 4 and 5 headers are used within the boxes?
There was a problem hiding this comment.
I have updated the H3 and H4 headers as part of my PR, so once merged in, they should look more different to H3. I think for accessibility reasons we shouldn't skip header levels so be good to get no levels missing and then once merged in it will look different, or you could also add the same code to the styles.css page to see how it looks
There was a problem hiding this comment.
Level 1 and 3 were skipped on purpose, curious as to how it impacts accessibility, have changed now so that no levels are skipped.
Lsnaathorst1
left a comment
Lsnaathorst1
left a comment
There was a problem hiding this comment.
Hey Matt,
Thank you for this! Having a look at some of the common issues, I had a piece of general feedback for across all of the common issues on the first one, I think we could lay them out to have the first paragraph being the explanation of what the resolution is for each and then just tighten up some of the explanations and resolutions. I will add an example for a question too where it may be feels less obvious. Will leave this back with you and let me know when ready for a review! :)
|
|
||
| #### No Simba Spark ODBC Driver | ||
|
|
||
| When you download Simba Spark it doesn't necessarily download the data driver, to do this raise an I.T. ticket explaining that you have installed "Simba Spark" but the driver is missing, they will download it from the internet. |
There was a problem hiding this comment.
I think it might be helpful to lay these out with the resolution clearly labelled. Maybe the first paragraph for each should be an explanation of the issue, plus when people might come across it, and then the resolution header with step by step instructions?
Also, does this one come from an issue someone raised on Databricks support on teams? If so, maybe we can add a bit more context as to what people may see. I can't see anywhere we are telling people to create a new data source as in that teams issue, but if we are then maybe we can link to that here.
No Simba Spark ODBC Driver
After installing Simba Spark, the ODBC driver by not be included by default. You may see installation errors and will not be able to add the 'Simba Spark ODBC Driver' when creating a new data source.
Resolution
Raise an I.T. ticket explaining that you have installed "Simba Spark" but the driver is missing so it can be installed.
There was a problem hiding this comment.
Added in issue and resolution for each.
I think some of these were an amalgamation of several teams issues. I'm not sure I follow what you are talking about with a new data source?
| #### Temporary tables | ||
| Temporary tables do not work for Databricks runtimes before 18.1, Databricks [temporary table guidance](https://docs.databricks.com/gcp/en/tables/temporary-tables) | ||
|
|
||
| #### Tables vs Volumes |
There was a problem hiding this comment.
Example suggestion for how we could give a little more info, add in where people might come across this and lay out with the resolution header:
Tables vs Volumes
It is common to confuse volumes and tables when working in Databricks. If you try to refer to a volume in the same way you would a table, you may see SQL queries fail, or you may find you are unable to query files in a volume in the way you expect.
Resolution
Tables store structured data and can be queried directly through SQL. Volumes, however, are designed for file-based (unstuctured or semi-structured) storage and are not directly accessible via standard SQL queries.
To access data in a volume, you must use the appropriate file path rather than SQL table references. You can find guidance on the differences on the Databricks’ guidance: volumes and Databricks’ guidance: volume paths pages.
There was a problem hiding this comment.
I'm struggling to see what more info to give
2 participants
Overview of changes
Have added a Databricks common errors page with folders in the image folder.
Why are these changes being made?
To keep track of issues people have with Databricks for easy self-diagnosis.
Detailed description of changes
Have added a key issue drop down plus 5 dropdowns partitioning the issues into their most common categories:
I've then sourced any questions from the team's channel and our own knowledge of issues and added them to the page with their respective solutions.
Issue ticket number/s and link
Checklist before requesting a review