Bug: sink syntax not consist with doc

[yufansong]

Describe the bug

In our doc, it seems we already claim all sink already support FORMAT ... ENCODE ... syntax. We do this change in #12556, but acutally not all sink support it. For example our NATS doc, the example command is:

CREATE SINK [ IF NOT EXISTS ] sink_name
[FROM sink_from | AS select_query]
WITH (
   connector='nats',
   server_url='<your nats server>:<port>', [ <another_server_url_if_available>, ...]
   subject='<your subject>',

 -- optional parameters
   connect_mode=<connect_mode>
   username='<your user name>',
   password='<your password>'
   jwt=`<your jwt>`,
   nkey=`<your nkey>`
)
FORMAT PLAIN ENCODE JSON;

But when try locally in latest main, it will show:

dev=> create sink s1 as
dev-> select
dev->     *
dev-> from
dev->     person with (
dev(>         connector = 'nats',
dev(>         server_url = 'localhost:4222',
dev(>         subject = 'event1',
dev(>     ) format plain encode json;
ERROR:  Failed to run the query

Caused by:
  Bind error: connector nats is not supported by FORMAT ... ENCODE ... syntax
dev=> 

I guess some other sink doc may also exist this problem.

Error message/log

No response

To Reproduce

Start nats locally nats-server -js
Then try following:

CREATE TABLE person (
    id integer,
    name varchar,
);

INSERT INTO person VALUES (1, 'Alice'), (2, 'Bob');
INSERT INTO person VALUES (3, 'Tom'), (4, 'Jerry');

FLUSH;

# this will fail
create sink s1 as
select
    *
from
    person with (
        connector = 'nats',
        server_url = 'localhost:4222',
        subject = 'event1',
    ) format plain encode json;

# this will sucess
create sink s1 as
select
    *
from
    person with (
        connector = 'nats',
server_url = '0.0.0.0:4222',
subject = 'event1',
type = 'append-only',
force_append_only = 'true',
connect_mode = 'plain'
    );

Expected behavior

No response

How did you deploy RisingWave?

No response

The version of RisingWave

No response

Additional context

No response

[neverchanje]

I've no idea that

create sink s1 as
select
    *
from
    person with (
        connector = 'nats',
        server_url = 'localhost:4222',
        subject = 'event1',
    ) format plain encode json;

this will fail. @xiangjinwu Please help investigate the root cause. It's a kernel bug rather than a doc bug. Thanks.

[xiangjinwu]

The documentation section of the aforementioned PR clearly states that only kafka/kinesis/pulsar have been migrated to the new syntax. But yes we shall migrate nats as well.

Before that is actually done, doc shall be updated to match whatever kernel have implemented, acknowledging certain limitations.

[yufansong]

closed by changing docs risingwavelabs/risingwave-docs#1921