Job description

[maikel]

Hello!

Is there a way to add some job description with some information about parameters meaning e.g.? Or only notebook which is the source of job can be used for that?

Thank you!

[Kirankumarbs]

No, there's no description field on a Databricks job. People have been asking for it for years. Still nothing.

Here's what I've seen people do instead:

Tags work for short stuff. You can slap key-value pairs on a job owner, team, what the parameters mean if you keep it brief. They show up in the UI and you can query them through the API.

If you use Databricks Asset Bundles, you can put comments in the YAML next to each parameter. Doesn't show up in the UI, but anyone touching the code will see it, and it stays version-controlled.

Hope this helps! If it does, could you please mark it as "Accept as Solution"? That will help other users quickly find the correct fix.

[Ashwin_DSA · Accepted solution]

Hi @maikel , @Kirankumarbs,

I am keen to understand what exactly you are looking for. There is a description field that you can use at job level. Are you looking for something else?

 If this answer resolves your question, could you mark it as “Accept as Solution”? That helps other users quickly find the correct fix.

[Kirankumarbs]

> with some information about parameters meaning
May be i misunderstood a simple question. @maikel, please correct otherwise!

I was thinking some metadata on Job Level which we can query via API or through System tables! For example i am adding below custom tags which i am  querying from System Tables to show it on Databricks Dashboard!

If this is a simple Job Description, then @Ashwin_DSA answer is perfect!

[Ashwin_DSA]

Ok, great. You can also access these tables via APIs and SQL queries if required.

Here are some relevant links if you are interested...

https://docs.databricks.com/aws/en/admin/system-tables/jobs

https://docs.databricks.com/aws/en/dev-tools/bundles/resources

And here is a sample SQL script... gives you the latest version of the job and it's description. 

SELECT
workspace_id,
job_id,
name,
description
FROM system.lakeflow.jobs
QUALIFY ROW_NUMBER() OVER (PARTITION BY workspace_id, job_id ORDER BY change_time DESC) = 1;

If this answer resolves your question, could you mark it as “Accept as Solution”? That helps other users quickly find the correct fix.

[maikel]

@Ashwin_DSA 

how can I add it through configuration yaml?

Thanks!

[maikel]

OK! I found it:

resources:
  jobs:
    example_job:
      name: example_job${bundle.target}
      description: "y description"

Thanks a lot!