Two points about docs

Started by Vladimir Chukharevabout 21 years ago11 messagesdocs
Jump to latest
#1Vladimir Chukharev
chu@kemia.me.tut.fi

Hi,

I think that docs can be improved a bit in two places.

1. Description of SELECT ( http://www.postgresql.org/docs/8.0/static/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

#2Bruce Momjian
bruce@momjian.us
In reply to: Vladimir Chukharev (#1)
Re: Two points about docs

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/static/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

Attachments:

/bjm/difftext/plainDownload+4-4
#3Bruce Momjian
bruce@momjian.us
In reply to: Bruce Momjian (#2)
Re: Two points about docs

Vladimir Chukharev wrote:

On Sun, 08 May 2005 06:18:04 +0300, Bruce Momjian <pgman@candle.pha.pa.us> wrote:

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.

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
#4Vladimir Chukharev
chu@kemia.me.tut.fi
In reply to: Bruce Momjian (#3)
Re: Two points about docs

On Tue, 10 May 2005 04:50:16 +0300, Bruce Momjian <pgman@candle.pha.pa.us> wrote:

Vladimir Chukharev wrote:

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.

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

#5Michael Glaesemann
grzm@seespotcode.net
In reply to: Vladimir Chukharev (#4)
Re: Two points about docs

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

#6Bruce Momjian
bruce@momjian.us
In reply to: Vladimir Chukharev (#4)
Re: Two points about docs

Vladimir Chukharev wrote:

On Tue, 10 May 2005 04:50:16 +0300, Bruce Momjian <pgman@candle.pha.pa.us> wrote:

Vladimir Chukharev wrote:

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.

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

Attachments:

/bjm/difftext/plainDownload+4-4
#7Tom Lane
tgl@sss.pgh.pa.us
In reply to: Michael Glaesemann (#5)
Re: Two points about docs

Michael Glaesemann <grzm@myrealbox.com> writes:

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? :)

I think this is more conventionally called an index ;-)

regards, tom lane

#8Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#6)
Re: Two points about docs

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

#9Michael Glaesemann
grzm@seespotcode.net
In reply to: Tom Lane (#7)
Re: Two points about docs

On May 11, 2005, at 22:39, Tom Lane wrote:

Michael Glaesemann <grzm@myrealbox.com> writes:

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 ;-)

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

#10Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#8)
Re: Two points about docs

Tom Lane wrote:

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.

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
#11Vladimir Chukharev
chu@h33.erkki.ton.tut.fi
In reply to: Michael Glaesemann (#5)
Re: Two points about docs

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:

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? :)

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