Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / fpc-pascal / 2011-11

Firebird Connection documentation: suggestions? remarks?

7 messages · 3 people · –

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Reinier Olislagers

Hi list,

Please find attached my current version for the Interbase/Firebird connection documentation source. If the attachment gets deleted by the list or if you want to see the latest version, please go to https://bitbucket.org/reiniero/fpc_laz_patch_playground/src directory docs

I have some doubts/questions:
1. Do I need to document inherited properties etc or will a documented parent unit's help filter down? (I suspectOf course, I'll figure that out when I get pdf generation working)
2. What is the TIBConnectionDef/TConnectionDef class used for? Actually, I don't understand registering/unregistering connections. SQLDB maintains a connection list with connections, but what happens with that/what do you use it for? Some kind of connection pooling?

Note that I'll go over everything to make sure everything is actually valid XML, builds, seems to be proper English etc.

Comments, criticisms welcome. I'll adapt as necessary and when done, post it to mantis.
(And yes, for the next unit I'll just use makeskel to generate only public & published elements)

Thanks,
Reinier

Reinier Olislagers
to Reinier Olislagers
Reinier Olislagers wrote 8 lines
Hi list, Please find attached my current version for the Interbase/Firebird connection documentation source. If the attachment gets deleted by the list or if you want to see the latest version, please go to https://bitbucket.org/reiniero/fpc_laz_patch_playground/src directory docs

Updated; it is valid XML, edited in Lazarus Documentation Editor. Comments/criticisms welcome.

Still don't understand what the TIBConnectionDef/TConnectionDef class is used for?
Actually, I don't understand registering/unregistering connections. SQLDB maintains a connection list with connections, but what happens with that/what do you use it for? Some kind of connection pooling?

Hints/tips welcome. If I can document TIBConnectionDef, I can upload this to Mantis and move on to the next unit ;)

Thanks,
Reinier

Ludo Brands
to Reinier Olislagers
Show quoted text 7 lines
Still don't understand what the TIBConnectionDef/TConnectionDef class is used for? Actually, I don't understand registering/unregistering connections. SQLDB maintains a connection list with connections, but what happens with that/what do you use it for? Some kind of connection pooling?

It is used in the generic TSQLConnector. When you specify the ConnectorType it checks this value against the registered TXXXConnectionDef.TypeName and, if it matches, uses the corresponding TXXXConnection.

Ludo

Unknown author
to Reinier Olislagers: Updated; it is valid XML, edited in Lazarus Documentation Editor. Comments/criticisms…
Reinier Olislagers wrote 15 lines
On 19-11-2011 14:21, Reinier Olislagers wrote: > Hi list, > > Please find attached my current version for the Interbase/Firebird > connection documentation source. If the attachment gets deleted by the > list or if you want to see the latest version, please go to > https://bitbucket.org/reiniero/fpc_laz_patch_playground/src > directory docs > Updated; it is valid XML, edited in Lazarus Documentation Editor. Comments/criticisms welcome. Still don't understand what the TIBConnectionDef/TConnectionDef class is used for?

It is uses for the TSQLConnector component.

Actually, I don't understand registering/unregistering connections. SQLDB maintains a connection list with connections, but what happens with that/what do you use it for? Some kind of connection pooling?

It does not register a connection. It registers a connection type, this is different.

in TSQLConnector you say Type = 'IBConnection' (or something like it) and then it searches in the list of registered types for the type it must create, and creates it.

Michael.

Reinier Olislagers
to Unknown author
Show quoted text 17 lines
> Still don't understand what the TIBConnectionDef/TConnectionDef class is > used for? It is uses for the TSQLConnector component. > Actually, I don't understand registering/unregistering connections. > SQLDB maintains a connection list with connections, but what happens > with that/what do you use it for? Some kind of connection pooling? > It does not register a connection. It registers a connection type, this is different. in TSQLConnector you say Type = 'IBConnection' (or something like it) and then it searches in the list of registered types for the type it must create, and creates it.

Duh. It all seems so clear now: it is more to do with having a "connection factory" that can pick a specialized connector for you at runtime rather than something to do with connection pooling etc. The end result is that you can write a database-independent program, add run-time configuration and some drivers and let the client choose the database server, right?

Thanks, you 2.

Regards,
Reinier

Unknown author
to Reinier Olislagers
Reinier Olislagers wrote 24 lines
On 22-11-2011 10:32, wrote: >> Still don't understand what the TIBConnectionDef/TConnectionDef class is >> used for? > > It is uses for the TSQLConnector component. > >> Actually, I don't understand registering/unregistering connections. >> SQLDB maintains a connection list with connections, but what happens >> with that/what do you use it for? Some kind of connection pooling? >> > > It does not register a connection. It registers a connection type, this is > different. > > in TSQLConnector you say Type = 'IBConnection' (or something like it) > and then it searches in the list of registered types for the type it must > create, and creates it. > Duh. It all seems so clear now: it is more to do with having a "connection factory" that can pick a specialized connector for you at runtime rather than something to do with connection pooling etc. The end result is that you can write a database-independent program, add run-time configuration and some drivers and let the client choose the database server, right?

Exactly.

Michael.

Reinier Olislagers
to Reinier Olislagers: Please find attached my current version for the Interbase/Firebird connection…
Reinier Olislagers wrote
Hi list, Please find attached my current version for the Interbase/Firebird connection documentation source.

<snip>

I have some doubts/questions: 1. Do I need to document inherited properties etc or will a documented parent unit's help filter down? (I suspectOf course, I'll figure that out when I get pdf generation working)

Have uploaded documentation as patch 20735.

Regards,
Reinier