tediousjs
README.md for Integrated Login is both missing and unclear
Expected behaviour: I expected to read the documentation and be able to efficiently and accurately create a connection pool that uses Windows integrated login.
Actual behaviour: After attempting to read the documentation I am confused and uncertain about how to do this or if it is even possible, although some of the inconsistencies indicate that it might be.
Some of the docs say use msnodesqlv8, some say it’s a separate installation, some say it was added, some say it was removed. Some say use a connection string different from mssql, some implies just add an options property called “trustedConnection: true” — or is it “YES”?? That’s also completely unclear.
Configuration:
// paste relevant config here
Software versions
- NodeJS:
- node-mssql:
- SQL Server:
What docs are you referring to specifically? It would be useful to provide some links to the offending docs so there there isn't any ambiguity with what areas you feel need to be improved.
As always, PRs welcome.
LOL if I could write a PR I wouldn’t need the doc. But if you show me how to create a pool using integrated login (using options object instead of connection string if that’s possible), I’ll write one! 👍
I’m referring to the README.md.
The authentication negotiation is all handled by the underlying drivers, so it depends what driver your using and what the docs in that driver say.
Assuming you're using tedious there are a couple issues open about NTLM/windows login which may help you get to the bottom of it.
I'm not in the habit of trying to document underlying driver features, because that becomes an overhead trying to keep docs in sync.
I understand the desire not to be saddled with documenting other people’s projects but OTOH, by sanctioning the driver as you’ve done already in both code and docs, I think you take on the responsibility to provide some indications on how it integrates with your code and how to perform basic operations with it. In fact, I understood that MS started including the msnodesqlv8 driver in mssql because it enabled integrated login and it was more convenient than supporting your own C++ build steps.
Documenting basic things like where mssql techniques end and driver techniques start, basic operations like pool creation, etc., should be included in the enclosing project — especially when it’s the only option to perform an operation.
I do sympathize since msnodesqlv8’s documentation provides no real help at all. But using that inside mssql is even more confusing.
I read that NTLM is obsolete and Kerberos is the only integrated option in up-to-date installations.
The integration points are documented, and how to create pools, etc (which is this library's job) are likewise documented.
The problem comes with then documenting the options that can be passed directly to the drivers (via config.options prop). Where does my responsibility for going over all the options begin and end? It'd also be rather disingenuous to provide examples that I can't test or verify work, so then I'm juts copy/paste-ing docs/examples from elsewhere with some implied guarantee they are correct when I haven't validated them. As you can see, I've provided some light documentation around common options and authentication, perhaps it would be clearer to point users to the drivers' docs too.
I don't have an installation using integrated login so I can't test or provide examples for it - those are features provided by the underlying drivers and, as such, should be found in their docs. If their docs are not clear or accurate, that's an issue to raise with them.
LOL if I could write a PR I wouldn’t need the doc. But if you show me how to create a pool using integrated login (using options object instead of connection string if that’s possible), I’ll write one! 👍
I’m referring to the README.md.
On Aug 8, 2022, at 4:51 AM, Daniel Hensby @.***> wrote:
What docs are you referring to specifically? It would be useful to provide some links to the offending docs so there there isn't any ambiguity with what areas you feel need to be improved.
As always, PRs welcome.
— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.