DOCSP-41959 - Connection Options #112

mongoKart · 2024-08-21T22:25:12Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-41959
Staging: https://deploy-preview-112--docs-php-library.netlify.app/connect/connection-options/

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?

norareidy

Looks good, requesting changes since I left a question about API docs!

source/connect/connection-options.txt

norareidy

LGTM!

mongoKart · 2024-09-06T16:18:03Z

@GromNaN Will you have a chance to review this soon?

source/includes/connect/connection-options.php

netlify · 2024-09-11T18:30:07Z

✅ Deploy Preview for docs-php-library ready!

Name	Link
🔨 Latest commit	`dca4565`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-php-library/deploys/66f70c8dac557400080a22fa
😎 Deploy Preview	https://deploy-preview-112--docs-php-library.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

source/connect/connection-options.txt

jmikola · 2024-09-26T18:59:37Z

source/connect/connection-options.txt

+
+       **Connection URI Example**: ``readPreferenceTags=region:east,region:west``
+
+Authentication Options


Isn't there an existing auth mechanism tutorial that we can link to, as you did for the TLS options above? I'm not sure if that existed at the original time you opened this PR.

Or should this stay anyway since it's only three options (noting TLS has many more)?

No, I think it works well to link out instead. I do see that this page documented the authMechanismProperties option, which I don't see anywhere on the Authentication page. Does the PHP lib. support any mechanisms that use this option?

GSSAPI supports a few mechanism properties, two of which were originally top-level URI options before being deprecated: gssapiServiceName and canonicalizeHostname (still documented for Manager::__construct()).

MONGODB-AWS also supports a AWS_SESSION_TOKEN property, but I see that wasn't demonstrated in #139 (cc: @norareidy).

source/connect/connection-options.txt

source/includes/connect/connection-options.php

source/reference/class/MongoDBClient.txt

…p-41959-connection-options

jmikola

LGTM with suggestions applied.

source/connect/connection-options.txt

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

* Add PR template * Scaffolding * DOCSP-41953: Create a deployment (#93) * DOCSP-41953: Create a deployment * toc * add troubleshoot file * DOCSP-41954: Create a connection string (#99) * DOCSP-41954: Create a connection string * edits * spacing * DOCSP-42388: Next steps (#101) * DOCSP-41975: Retrieve data (#102) * DOCSP-41975: Retrieve data * fixes * quotes * code fix * JS feedback * JT feedback * code format * fix * JT feedback 2 * edit * DOCSP-41952: Download and Install (#92) * DOCSP-41952: Download and Install * edits * toc, fixes * AS feedback * AS feedback 2 * typo * JT feedback * DOCSP-41976: Projection guide (#104) * DOCSP-41976: Projection guide * edits * fixes * code edits, output * JS feedback * JT feedback * DOCSP-41955: Connect to MongoDB (#100) * DOCSP-41955: Connect to MongoDB * edits * edit * RR feedback * typo * code edit * DOCSP-41974: Specify a query (#103) * DOCSP-41974: Specify a query * edits * output * fix * snooty.toml * RR feedback * code edits * DOCSP-41977: Specify documents to return (#105) * DOCSP-41977: Specify documents to return * edits * code output * toc * MM feedback, code edits * edit * JT feedback * edit * test * MM feedback 2 * DOCSP-41957 - Mongo Client (#106) Co-authored-by: Rea Rustagi <85902999+rustagir@users.noreply.github.com> * DOCSP-41960 - TLS (#114) * DOCSP-41978: Count documents (#108) * DOCSP-41978: Count documents * edits * code ex format * link * RR feedback * DOCSP-41979: Distinct values (#109) Adds a Distinct Values guide. * DOCSP-41981: Change streams (#113) Adds a Change Streams guide. * DOCSP-41993 Compatibility Table * test webhook * toc and sharedincludes * lang table * edits * headings * retry on shared include * shared includes * callout * help links * DOCSP-41958 - Connection Targets (#107) Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Andreas Braun <git@alcaeus.org> * tech review * DOCSP-41968: Update documents (#118) * DOCSP-41968: Update documents * snooty fix * edits * DOCSP-41967: Insert documents (#116) * DOCSP-41967: Insert documents * build * snooty * edit * JS feedback * JT feedback * JT feedback 2 * DOCSP-41980: Cursor guide (#110) * DOCSP-41980: Cursor guide * edits * code edits * output * vale fix * MM feedback * edit * fix code ex * edit * JT feedback * DOCSP-41988: Aggregation (#115) * DOCSP-41988: Aggregation * toc * edits * code edit * JS feedback * dev center * JM feedback * explain api link * JM feedback 2 * DOCSP-41983: indexes landing pg * wip * wip * MM PR fixes 1 * JM tech review 1 * JM tech review 1 * wip * wip * DOCSP-41969: Replace documents (#125) * DOCSP-41969: Replace documents * edits * wording * SA * JT feedback * JM tech review 2 * Add files via upload * DOCSP-41970: Delete documents (#128) Adds a guide that shows how to delete documents. * DOCSP-41984: single field index * wip * JS PR fixes 1 * wip * DOCSP-41986: multikey indexes * links * bullet pts * JS suggestion * fix whitespace per JM comment * uncomment * DOCSP-41985: compound idx * small fix * DOCSP-41966: Write operations landing (#135) * DOCSP-41966: Write operations landing * edits * RR feedback * JT feedback * JT feedback 2 * gridfs examples * DOCSP-42026: In use encryption (#142) * DOCSP-42026: In use encryption * edit * DOCSP-41972: GridFS guide (#133) * DOCSP-41972: GridFS guide * fixes * code edits * fix * RR feedback * phpmethod * fix * JM most feedback * alternate upload/download methods * file revisions * code fix * tojson * edits * JM feedback 2 * edits * JM last feedback * DOCSP-41971: Bulk write (#130) * DOCSP-41971: Bulk write * edits * JS feedback * api links * DOCSP-41987: atlas search idx * resolve todos * toc * DOCSP-41963: Databases and collections (#136) * DOCSP-41963: Databases and collections * edits * phpmethod * code fix * MW feedback * fix * MW feedback 2 * JM feedback * JM feedback 2 * JS fix * internal review * DOCSP-41982: cluster monitoring * small fixes * MW PR fixes 1 * test netlify * spacing * try using out of repo ref and add back legend * ou of repo ref * legend glitch * JM tech review 1 * single quotes * links * vale * remove older driver version past 1.15 * DOCSP-41991 What's New * add rest of versions * fix links * fix links * JM tech review 2 * DOCSP-41964: Time series collections (#138) * DOCSP-41964: Time series collections * toc * edits * keywords * SA feedback * JT feedback * JM final fixes * review comments * typo * DOCSP-41973 Read Landing Page * review comments * vale errors * small thing * full page with ex * add page * meta * DOCSP-41965: Read and write settings (#146) * DOCSP-41965: Read and write settings * more info * edits * edits * headers * fix link * fix * RR feedback * api docs * fix * fix * DOCSP-41950: Landing page (#150) * DOCSP-41950: Landing page * fix build errors * fixes, data formats * toc * fix * data formats folder * RR feedback * fix * remove file * edit sample app intro * change links in count sections * update sample app intro * DOCSP-41990: Authentication mechanisms (#139) * DOCSP-41990: Authentication mechanisms * client tabs * edits * edits * add info * reduce repetition * add section * fix link * MW feedback * fix * JM most feedback * move to code file * more JM edits * JM feedback 2 * DOCSP-41989: Security landing page (#149) * DOCSP-41989: Security landing page * more info * edits * snooty.toml * edits * RR feedback * JM feedback * DOCSP-41962 - Stable API (#117) Co-authored-by: Jeremy Mikola <jmikola@gmail.com> * DOCSP-41992 Upgrade versions * toc * edits * how to upgrade sections * style * edit * edit * review comments * ref * Revise descriptions for server opening/closed events * DOCSP-43204: Connection landing page (#147) * DOCSP-43204: Connection landing page * toc edit * edits * remove compression * fix * sample app * snooty * JM feedback * replica set * JM feedback 2 * JM last feedback * DOCSP-43819: php 1.20 release * fix * DOCSP-41956: run a command * wip * formatting fix * JS PR fixes 1 * link fix * style fixes * JT tech review 1 * wip * JM tech review * tree * api links * links * JM tech review 2 * small fixes * add ext upgrade command * DOCSP-41995: transaction * wip * update code * NR PR fixes 1 * wip * add emphasis * add with_txn() method to api links * cxn string env * edit * JM tech review 1 * remove dupe sc * tech review * wrap fix * edit copy * DOCSP-41959 - Connection Options (#112) Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Jeremy Mikola <jmikola@gmail.com> * DOCSP-43396: Cleanup (#151) * DOCSP-43396: Cleanup * quickstart fix * code fixes * edit * snooty * edit * code output * build log errors * another build fix * add info * upgrade guide to landing * fix * driver mentions * RR feedback * build fix * build fix * php directives --------- Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Co-authored-by: Rea Rustagi <85902999+rustagir@users.noreply.github.com> Co-authored-by: Lindsey Moore <lindsey.moore@mongodb.com> Co-authored-by: Andreas Braun <git@alcaeus.org> Co-authored-by: rustagir <rea.rustagi@mongodb.com> Co-authored-by: Brandon Ly <brandonly@lostcoding.com> Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com> Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

mongoKart added 26 commits August 21, 2024 15:31

wip

45739f4

formatting

1df7cf0

format

7d07a4d

test

d505ef1

test

5fcd405

test

aa3a2f3

test

d7e5227

test

0dbe1e6

test

916ed85

test

73dc918

test

9767bfd

test

bf43a6c

test

6bfb367

test

3a4ead0

test

d68b868

test

8f5a381

make one column

2296609

test

c90ad5d

test

b31f3fc

test

790ffdf

test

8ca2f3d

test

fa9622a

test

69584e5

test

96999b3

test

3d777f0

add emphasis

5779b96

mongoKart marked this pull request as ready for review August 22, 2024 16:53

mongoKart added 2 commits August 22, 2024 11:54

remove extra file

3c2a761

add source constant

a1470a6

norareidy requested changes Aug 22, 2024

View reviewed changes

source/connect/connection-options.txt Outdated Show resolved Hide resolved

source/connect/connection-options.txt Outdated Show resolved Hide resolved

source/connect/connection-options.txt Outdated Show resolved Hide resolved

source/connect/connection-options.txt Show resolved Hide resolved

feedback

db5a290

mongoKart requested a review from norareidy August 22, 2024 18:44

norareidy approved these changes Aug 22, 2024

View reviewed changes

mongoKart requested review from a team, mana2-bot and GromNaN and removed request for a team and mana2-bot August 22, 2024 21:40

GromNaN requested changes Sep 6, 2024

View reviewed changes

source/includes/connect/connection-options.php Outdated Show resolved Hide resolved

source/includes/connect/connection-options.php Outdated Show resolved Hide resolved

source/includes/connect/connection-options.php Outdated Show resolved Hide resolved

feedback

b6088f8

phpclass

7cd7c30

mongoKart requested a review from GromNaN September 11, 2024 18:31

jmikola reviewed Sep 26, 2024

View reviewed changes

mongoKart added 4 commits September 27, 2024 11:40

Merge remote-tracking branch 'upstream/php-standardization' into docs…

fa842ac

…p-41959-connection-options

feedback

5a519a4

add toc link

2eb98ea

stable api link

20a4817

mongoKart requested a review from jmikola September 27, 2024 18:11

jmikola approved these changes Sep 27, 2024

View reviewed changes

Apply suggestions from code review

dca4565

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

mongoKart removed the request for review from GromNaN September 27, 2024 19:51

mongoKart merged commit cf2b492 into mongodb:php-standardization Sep 27, 2024
5 checks passed

mongoKart deleted the docsp-41959-connection-options branch September 27, 2024 19:52


		Connection URI Example: ``readPreferenceTags=region:east,region:west``

		Authentication Options

DOCSP-41959 - Connection Options #112

DOCSP-41959 - Connection Options #112

Uh oh!

Conversation

mongoKart commented Aug 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Self-Review Checklist

Uh oh!

norareidy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

norareidy left a comment

Choose a reason for hiding this comment

Uh oh!

mongoKart commented Sep 6, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

netlify bot commented Sep 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-php-library ready!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jmikola Sep 26, 2024

Choose a reason for hiding this comment

Uh oh!

mongoKart Sep 27, 2024

Choose a reason for hiding this comment

Uh oh!

jmikola Sep 27, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jmikola left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mongoKart commented Aug 21, 2024 •

edited

Loading

netlify bot commented Sep 11, 2024 •

edited

Loading