Update quickstart command

[viv-tong]

Updating documentation. The command has been updated to from quickstart_catalog to polaris.

Checklist

• 🛡️ Don't disclose security issues! (contact security@apache.org)
• 🔗 Clearly explained why the changes are needed, or linked related issues: Fixes #
• 🧪 Added/updated tests with good coverage, or manually tested (and explained how)
• 💡 Added comments for complex logic
• 🧾 Updated CHANGELOG.md (if needed)
• 📚 Updated documentation in site/content/in-dev/unreleased (if needed)

[adnanhemani]

Quickstart seems to be broken by #2963. I've opened an issue to get all pieces of this issue fixed here: #3962. This change is a step in the right direction given the changes made by #2963, but does not fix all the issues. I will start investigating the rest of the problems being seen.

[flyrain]

I think quickstart_catalog is consistent with the value in the spark config above, see line 151.

Another option is to have this config in the spark config around line 151, so that we don't need the use xxx command.

 --conf spark.sql.defaultCatalog=quickstart_catalog

[dimas-b]

+1 to @flyrain 's points

[viv-tong]

@flyrain Gotcha! Thanks for the feedback! I'll take a closer look on your suggestion over the weekend.

[adnanhemani]

this is another place where #2963 broke the quickstart. The docker-compose.yml file states "polaris" as the catalog name but the Spark block above states "quickstart_catalog".

[flyrain]

is this place setting the spark config? https://github.com/apache/polaris/blob/1e7bb1a6b077df4f7494925ed0a89ed7f09c3c59/getting-started/quickstart/docker-compose.yml#L269
If yes, we can add this line to there, and remove the line USE polaris; here.

 --conf spark.sql.defaultCatalog=polaris

We may add this to line 151 anyways, so that both work. WDYT?

 --conf spark.sql.defaultCatalog=quickstart_catalog

[MonkeyCanCode]

Maybe I missed something, but from the current getting start guide, it will still point users to https://raw.githubusercontent.com/apache/polaris/main/getting-started/quickstart/docker-compose.yml which is not longer a valid path due to it got moved into site dir (in this case, https://raw.githubusercontent.com/apache/polaris/refs/heads/main/site/content/guides/quickstart/docker-compose.yml). Then if we use the right path, it will work:

polaris-setup-1  | Creating catalog 'quickstart_catalog' in realm POLARIS...
polaris-1        | 2026-03-10 03:14:02,344 INFO  [org.apa.pol.ser.adm.PolarisServiceImpl] [96ac5847-18bf-45c3-a7b6-2b4e16b8eafb_0000000000000000002,POLARIS] [,,,] (executor-thread-1) Created new catalog class PolarisCatalog {
polaris-1        |     class Catalog {
polaris-1        |         type: INTERNAL
polaris-1        |         name: quickstart_catalog
polaris-1        |         properties: class CatalogProperties {
polaris-1        |             {default-base-location=s3://bucket123}
polaris-1        |             defaultBaseLocation: s3://bucket123
polaris-1        |         }
polaris-1        |         createTimestamp: 1773112442341
polaris-1        |         lastUpdateTimestamp: 0
polaris-1        |         entityVersion: 1
polaris-1        |         storageConfigInfo: class AwsStorageConfigInfo {
polaris-1        |             class StorageConfigInfo {
polaris-1        |                 storageType: S3
polaris-1        |                 allowedLocations: [s3://bucket123]
polaris-1        |             }
polaris-1        |             roleArn: null
polaris-1        |             externalId: null
polaris-1        |             userArn: null
polaris-1        |             currentKmsKey: null
polaris-1        |             allowedKmsKeys: []
polaris-1        |             region: null
polaris-1        |             endpoint: http://localhost:9000
polaris-1        |             stsEndpoint: null
polaris-1        |             stsUnavailable: null
polaris-1        |             endpointInternal: http://rustfs:9000
polaris-1        |             pathStyleAccess: true
polaris-1        |             kmsUnavailable: null
polaris-1        |         }
polaris-1        |     }
polaris-1        | }
polaris-1        | 2026-03-10 03:14:02,349 INFO  [io.qua.htt.access-log] [96ac5847-18bf-45c3-a7b6-2b4e16b8eafb_0000000000000000002,POLARIS] [,,,] (executor-thread-1) 172.18.0.4 - root [10/Mar/2026:03:14:02 +0000] "POST /api/management/v1/catalogs HTTP/1.1" 201 374

[dimas-b]

Yes, we need to fix the URL to the docker-compose YAML file 👍

[viv-tong]

Maybe I missed something, but from the current getting start guide, it will still point users to https://raw.githubusercontent.com/apache/polaris/main/getting-started/quickstart/docker-compose.yml which is not longer a valid path due to it got moved into site dir (in this case, https://raw.githubusercontent.com/apache/polaris/refs/heads/main/site/content/guides/quickstart/docker-compose.yml). Then if we use the right path, it will work:

polaris-setup-1  | Creating catalog 'quickstart_catalog' in realm POLARIS...
polaris-1        | 2026-03-10 03:14:02,344 INFO  [org.apa.pol.ser.adm.PolarisServiceImpl] [96ac5847-18bf-45c3-a7b6-2b4e16b8eafb_0000000000000000002,POLARIS] [,,,] (executor-thread-1) Created new catalog class PolarisCatalog {
polaris-1        |     class Catalog {
polaris-1        |         type: INTERNAL
polaris-1        |         name: quickstart_catalog
polaris-1        |         properties: class CatalogProperties {
polaris-1        |             {default-base-location=s3://bucket123}
polaris-1        |             defaultBaseLocation: s3://bucket123
polaris-1        |         }
polaris-1        |         createTimestamp: 1773112442341
polaris-1        |         lastUpdateTimestamp: 0
polaris-1        |         entityVersion: 1
polaris-1        |         storageConfigInfo: class AwsStorageConfigInfo {
polaris-1        |             class StorageConfigInfo {
polaris-1        |                 storageType: S3
polaris-1        |                 allowedLocations: [s3://bucket123]
polaris-1        |             }
polaris-1        |             roleArn: null
polaris-1        |             externalId: null
polaris-1        |             userArn: null
polaris-1        |             currentKmsKey: null
polaris-1        |             allowedKmsKeys: []
polaris-1        |             region: null
polaris-1        |             endpoint: http://localhost:9000
polaris-1        |             stsEndpoint: null
polaris-1        |             stsUnavailable: null
polaris-1        |             endpointInternal: http://rustfs:9000
polaris-1        |             pathStyleAccess: true
polaris-1        |             kmsUnavailable: null
polaris-1        |         }
polaris-1        |     }
polaris-1        | }
polaris-1        | 2026-03-10 03:14:02,349 INFO  [io.qua.htt.access-log] [96ac5847-18bf-45c3-a7b6-2b4e16b8eafb_0000000000000000002,POLARIS] [,,,] (executor-thread-1) 172.18.0.4 - root [10/Mar/2026:03:14:02 +0000] "POST /api/management/v1/catalogs HTTP/1.1" 201 374

@MonkeyCanCode - Yes, we ran into this issue yesterday with the paths. @adnanhemani said he has to take a closer look as to whether updating getting-started to site/content/guides is the correct path moving forward or if getting-started is the intended path.

I can update the docs over the weekend if there's a consensus of what the correct path forward is.

[adnanhemani]

We should point all "getting-started/" references into "site/content/guides".

[MonkeyCanCode]

We should point all "getting-started/" references into "site/content/guides".

I think this is the only one where we are using a absolute URL. In other places such as the aws/gcp/azure ones, it is still pointing to getting-started but that is still valid as it is with path to the repo which we have soft link for this:

lrwxr-xr-x   1 yong  staff     20 Mar 11 21:33 getting-started -> site/content/guides/