|
Home > Archive > PostgreSQL Documentation > May 2005 > Two points about docs
You are viewing an archived Text-only version of the thread.
To view this thread in it's original format and/or if you want to reply to
this thread please [click here]
| Author |
Two points about docs
|
|
| Vladimir Chukharev 2005-04-01, 7:02 am |
| Hi,
I think that docs can be improved a bit in two places.
1. Description of SELECT ( http://www.postgresql.org/docs/8.0/...sql-select.html )
says 'SELECT retrieves rows from one or more tables.' This is not perfectly
correct, because 0 tables can be used like in 'SELECT 1;'. When I tried to find
how I can check the meaning of some simple function, at first attempt I really
thought that SELECT cannot be used without tables.
Chapter 7.1 also says that the simpleast query is 'SELECT * FROM table1;',
but at least the example 'SELECT 3 * 4;' is close enough to catch an eye.
2. 'Chapter 9. Functions and Operators' has no reference to server side
functions for large object manipulation (lo_creat et al.) Yesterday wanted
to check the names of those functions (I remembered there are some in psql).
So, first I found that blob is a keyword, but is not implemented. Then I tried
to find them in Chapter 9. I just couldn't beleave it's not there. Then I tried
to find a list of all functions, similar to list of all keywords. And only
after all that I found the location of the lo_* functions.
Well, may it is just me, of course. I don't know...
--
V.Chukharev
---------------------------(end of broadcast)---------------------------
TIP 8: explain analyze is your friend
| |
| Bruce Momjian 2005-05-08, 3:23 am |
|
I have added your first two suggestions. Not sure where to put the
large object links in the function section. It seems out of place there
to me.
---------------------------------------------------------------------------
Vladimir Chukharev wrote:
> Hi,
>
> I think that docs can be improved a bit in two places.
>
> 1. Description of SELECT ( http://www.postgresql.org/docs/8.0/...sql-select.html )
> says 'SELECT retrieves rows from one or more tables.' This is not perfectly
> correct, because 0 tables can be used like in 'SELECT 1;'. When I tried to find
> how I can check the meaning of some simple function, at first attempt I really
> thought that SELECT cannot be used without tables.
>
> Chapter 7.1 also says that the simpleast query is 'SELECT * FROM table1;',
> but at least the example 'SELECT 3 * 4;' is close enough to catch an eye.
>
> 2. 'Chapter 9. Functions and Operators' has no reference to server side
> functions for large object manipulation (lo_creat et al.) Yesterday wanted
> to check the names of those functions (I remembered there are some in psql).
> So, first I found that blob is a keyword, but is not implemented. Then I tried
> to find them in Chapter 9. I just couldn't beleave it's not there. Then I tried
> to find a list of all functions, similar to list of all keywords. And only
> after all that I found the location of the lo_* functions.
>
> Well, may it is just me, of course. I don't know...
>
> --
> V.Chukharev
>
> ---------------------------(end of broadcast)---------------------------
> TIP 8: explain analyze is your friend
>
--
Bruce Momjian | http://candle.pha.pa.us
pgman@candle.pha.pa.us | (610) 359-1001
+ If your life is a hard drive, | 13 Roberts Road
+ Christ can be your backup. | Newtown Square, Pennsylvania 19073
| |
| Bruce Momjian 2005-05-10, 3:24 am |
| Vladimir Chukharev wrote:
> On Sun, 08 May 2005 06:18:04 +0300, Bruce Momjian <pgman@candle.pha.pa.us> wrote:
>
>
> Thanks!
>
> About the link to the lo_* functions. I thought about adding
> a sentence to Charpter 9 like 'And functions to manipulate large
> objects are presented in Charpter 28.' right after the phrase
> 'Users can also define their own functions and operators, as
> described in Part V.'
>
> Do you think it's suitable?
Not really. We don't mention pg_stat_activity functions either. I
think people have to realize that some functions are covered in other
sections of the manual. There is a clearly titled section for large
objeccts.
--
Bruce Momjian | http://candle.pha.pa.us
pgman@candle.pha.pa.us | (610) 359-1001
+ If your life is a hard drive, | 13 Roberts Road
+ Christ can be your backup. | Newtown Square, Pennsylvania 19073
---------------------------(end of broadcast)---------------------------
TIP 1: subscribe and unsubscribe commands go to majordomo@postgresql
.org
| |
| Vladimir Chukharev 2005-05-11, 3:24 am |
| On Tue, 10 May 2005 04:50:16 +0300, Bruce Momjian <pgman@candle.pha.pa.us> wrote:
> Vladimir Chukharev wrote:
>
> Not really. We don't mention pg_stat_activity functions either. I
> think people have to realize that some functions are covered in other
> sections of the manual. There is a clearly titled section for large
> objeccts.
OK, what about writing down this idea? "Not all functions are listed
in this Chapter, some are in other sections of the manual."
And I still think that an additional Appendix with a list of all
functions and referencies to their descriptions would be very usefull.
Can you comment on that?
Best regards,
--
V.Chukharev
---------------------------(end of broadcast)---------------------------
TIP 8: explain analyze is your friend
| |
| Michael Glaesemann 2005-05-11, 3:24 am |
|
On May 11, 2005, at 15:50, Vladimir Chukharev wrote:
> And I still think that an additional Appendix with a list of all
> functions and referencies to their descriptions would be very usefull.
> Can you comment on that?
This has been brought up in the past. I don't think there's any reason
there can't be one. Want to make a function appendix? :)
Michael Glaesemann
grzm myrealbox com
---------------------------(end of broadcast)---------------------------
TIP 6: Have you searched our list archives?
http://archives.postgresql.org
| |
| Bruce Momjian 2005-05-11, 9:23 am |
| Vladimir Chukharev wrote:
> On Tue, 10 May 2005 04:50:16 +0300, Bruce Momjian <pgman@candle.pha.pa.us> wrote:
>
>
> OK, what about writing down this idea? "Not all functions are listed
> in this Chapter, some are in other sections of the manual."
OK, done.
--
Bruce Momjian | http://candle.pha.pa.us
pgman@candle.pha.pa.us | (610) 359-1001
+ If your life is a hard drive, | 13 Roberts Road
+ Christ can be your backup. | Newtown Square, Pennsylvania 19073
| |
| Tom Lane 2005-05-11, 9:23 am |
| Michael Glaesemann <grzm@myrealbox.com> writes:
> On May 11, 2005, at 15:50, Vladimir Chukharev wrote:
[color=darkred]
> This has been brought up in the past. I don't think there's any reason
> there can't be one. Want to make a function appendix? :)
I think this is more conventionally called an index ;-)
regards, tom lane
---------------------------(end of broadcast)---------------------------
TIP 4: Don't 'kill -9' the postmaster
| |
| Michael Glaesemann 2005-05-11, 9:23 am |
|
On May 11, 2005, at 22:39, Tom Lane wrote:
> Michael Glaesemann <grzm@myrealbox.com> writes:
>
>
> I think this is more conventionally called an index ;-)
Hehe :) Thanks, Tom! I don't know how the "i" and "e" got swapped
around, and that initial "app" is a complete mystery to me. Have to
check my mail software, I think. ;)
Michael Glaesemann
grzm myrealbox com
---------------------------(end of broadcast)---------------------------
TIP 9: the planner will ignore your desire to choose an index scan if your
joining column's datatypes do not match
| |
| Tom Lane 2005-05-11, 9:23 am |
| Bruce Momjian <pgman@candle.pha.pa.us> writes:
> ! consistent between the various implementations. This chapter is also
> ! not exhaustive; additional functions appear in relivant sections of
> ! the manual.
"relevant", please.
regards, tom lane
---------------------------(end of broadcast)---------------------------
TIP 4: Don't 'kill -9' the postmaster
| |
| Bruce Momjian 2005-05-11, 9:23 am |
| Tom Lane wrote:
> Bruce Momjian <pgman@candle.pha.pa.us> writes:
>
> "relevant", please.
Yea, Neil got it.
--
Bruce Momjian | http://candle.pha.pa.us
pgman@candle.pha.pa.us | (610) 359-1001
+ If your life is a hard drive, | 13 Roberts Road
+ Christ can be your backup. | Newtown Square, Pennsylvania 19073
---------------------------(end of broadcast)---------------------------
TIP 5: Have you checked our extensive FAQ?
http://www.postgresql.org/docs/faq
| |
| Vladimir Chukharev 2005-05-17, 11:24 am |
| On Wed, 11 May 2005 10:00:02 +0300, Michael Glaesemann <grzm@myrealbox.com> wrote:
>
> On May 11, 2005, at 15:50, Vladimir Chukharev wrote:
>
> This has been brought up in the past. I don't think there's any reason
> there can't be one. Want to make a function appendix? :)
OK, now I am trying to make the index. It will take time though, since
I can turn to it only when I'm _really sick_ with my PhD thesis :)
I made the list with psql \df command, and already found that
there is neither lo_write nor lo_read, but lowrite and loread instead...
Any idea what's wrong?
In addition I can find nothing about RI_FKey_* function.
Can you direct me please?
> Michael Glaesemann
> grzm myrealbox com
--
V.Chukharev
---------------------------(end of broadcast)---------------------------
TIP 6: Have you searched our list archives?
http://archives.postgresql.org
|
|
|
|
|