Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add per-driver connection information #11022

Closed
ericharmeling opened this issue Aug 9, 2021 · 9 comments · Fixed by #12538
Closed

Add per-driver connection information #11022

ericharmeling opened this issue Aug 9, 2021 · 9 comments · Fixed by #12538
Assignees
Labels
C-doc-improvement P-1 High priority; must be done this release

Comments

@ericharmeling
Copy link
Contributor

ericharmeling commented Aug 9, 2021

Eric Harmeling (ericharmeling) commented:

For each supported driver and ORM framework, we currently have download and installation information and example applications.

We do not have a dedicated page for connection information for each driver/ORM. I think users would find this information super helpful to have in one place (alla Install a Driver or ORM Framework), especially if we somehow linked to this page from the Connect page of the CC console (and possibly in the welcome page of the relevant cockroach commands).

All of the relevant connection information should be available on either the tool's example app tutorial page, or on the tool's third-party website.

Jira Issue: DOC-1745

@ericharmeling ericharmeling added A-sql P-1 High priority; must be done this release C-doc-improvement labels Aug 9, 2021
@ericharmeling ericharmeling added P-2 Normal priority; secondary task and removed P-1 High priority; must be done this release labels Aug 25, 2021
@vy-ton
Copy link
Contributor

vy-ton commented Oct 27, 2021

@ericharmeling @ianjevans @awoods187

In discussion with @emily-horing and @kannanlakshmi on connection questions from Serverless users, we should prioritize this as a Q4 OKR action/docs projects. It will greatly improve the onboarding journey

@awoods187
Copy link
Contributor

cc @kernfeld-cockroach

@ericharmeling ericharmeling self-assigned this Oct 27, 2021
@ericharmeling
Copy link
Contributor Author

we should prioritize this as a Q4 OKR action/docs projects.

+1

@jordanlewis
Copy link
Member

A user had a question about connecting with Ecto. The way to connect to Ecto is here:

config :myapp, MyApp.repo,
  username: "username",
  password: "xxxx",
  database: "defaultdb",
  hostname: "free-tier.gcp-us-central1.cockroachlabs.cloud",
  port: 26257,
  ssl: true,
  ssl_opts: [
    cert_pem: "foo.pem",
    key_pem:  "bar.pem"
  ],
  show_sensitive_data_on_connection_error: true,
  pool_size: 10,
  parameters: [
    options: "--cluster=cluster-name-1234"
  ]

@vy-ton
Copy link
Contributor

vy-ton commented Oct 28, 2021

@ericharmeling we should try and set up this page to make it easy for community contributions for things like Ecto in the future

@jordanlewis
Copy link
Member

I've written up instructions for JetBrains if they don't already exist here: https://stackoverflow.com/questions/69747102/how-do-i-connect-jetbrains-datagrip-to-cockroachdb-serverless/69747103#69747103

(And added the answer for Ecto here: https://stackoverflow.com/questions/69747033/how-do-i-connect-ecto-to-cockroachdb-serverless)

I do think that adding all of these to StackOverflow would be great too, as we move toward a product that's a lot more "consumer web facing" I think we'll see a lot more traffic in googleable places like StackOverflow. I'm happy to help write some of these things up there over time.

@jordanlewis
Copy link
Member

@exalate-issue-sync
Copy link

Jesse Seldess (jseldess) commented:
Eric Harmeling, flagging this as Dev Experience. Please change it to the appropriate SQL area, if necessary.

@exalate-issue-sync exalate-issue-sync bot added P-1 High priority; must be done this release and removed P-2 Normal priority; secondary task labels Nov 18, 2021
@exalate-issue-sync
Copy link

Vy Ton (vy-ton) commented:
fyi Paul Kernfeld I wanted to make sure you were aware of this issue so you and Eric Harmeling can prioritize accordingly. It was earmarked as a Q4 actions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-doc-improvement P-1 High priority; must be done this release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants