Skip to content

Conversation

@zymap
Copy link
Member

@zymap zymap commented Sep 11, 2019

OUTPUT

internal-info

➜  pulsarctl git:(topic-info) ✗ ./pulsarctl topic internal-info -h
USED FOR:
    This command is used for getting the internal info of a topic which has messages or subscriptions.

REQUIRED PERMISSION:
    This command requires tenant admin permissions.

EXAMPLES:
    #Get the internal info of a topic <topic-name>
    pulsarctl topic internal-info <topic-name>

OUTPUT:
    #normal output
    {
      "version": 1,
      "creationDate": "",
      "modificationData": "",
      "ledgers": [
        {
          "ledgerId": 0,
          "entries": 0,
          "size": 0,
          "timestamp": 0
        }
      ],
      "terminatedPosition": {
        "ledgerId": 0,
        "entryId": 0
      },
      "cursors": {
        "hello": {
          "version": 0,
          "creationDate": "",
          "modificationDate": "",
          "cursorsLedgerId": 0,
          "markDelete": {
            "ledgerId": 0,
            "entryId": 0
          },
          "individualDeletedMessages": null,
          "Properties": null
        }
      }
    }


    #the topic name is not specified
    [✖]  only one argument is allowed to be used as a name

    #the specified topic does not existing
    [✖]  code: 500 reason: Unknown pulsar error

    #the topic name is not in the format of <tenant>/<namespace>/<topic> or <topic>
    [✖]  Invalid short topic name '<topic-name>', it should be in the format of <tenant>/<namespace>/<topic> or <topic>

    #the topic name is not in the format of <domain>://<tenant>/<namespace>/<topic>
    [✖]  Invalid complete topic name '<topic-name>', it should be in the format of <domain>://<tenant>/<namespace>/<topic>

    #the topic name is not in the format of <tenant>/<namespace>/<topic>
    [✖]  Invalid topic name '<topic-name>', it should be in the format of<tenant>/<namespace>/<topic>

    #the namespace name is not in the format of <tenant>/<namespace>
    [✖]  The complete name of namespace is invalid. complete name : <namespace-complete-name>

    #the tenant name and(or) namespace name is empty
    [✖]  Invalid tenant or namespace. [<tenant>/<namespace>]

    #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%)  is allowed
    [✖]  Tenant name include unsupported special chars. tenant : [<namespace>]

    #the namespace name contains unsupported special chars. the  alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed
    [✖]  Namespace name include unsupported special chars. namespace : [<namespace>]

Usage: pulsarctl topics internal-info [flags]

@zymap zymap requested review from sijie and wolfstudy September 11, 2019 07:43
@zymap zymap self-assigned this Sep 11, 2019
@zymap zymap added this to the 0.0.1 milestone Sep 11, 2019
@sijie
Copy link
Member

sijie commented Sep 15, 2019

Please rebase and fix CI

@sijie sijie mentioned this pull request Sep 18, 2019
29 tasks
@zymap
Copy link
Member Author

zymap commented Sep 20, 2019

@sijie PTAL

@wolfstudy
Copy link
Contributor

ping @sijie PTAL again, thanks

@sijie sijie merged commit 787ff8a into master Sep 24, 2019
@sijie sijie deleted the topic-info branch September 24, 2019 06:13
tisonkun pushed a commit to tisonkun/pulsar-client-go that referenced this pull request Aug 15, 2023
### OUTPUT

*internal-info*
```
➜  pulsarctl git:(topic-info) ✗ ./pulsarctl topic internal-info -h
USED FOR:
    This command is used for getting the internal info of a topic which has messages or subscriptions.

REQUIRED PERMISSION:
    This command requires tenant admin permissions.

EXAMPLES:
    #Get the internal info of a topic <topic-name>
    pulsarctl topic internal-info <topic-name>

OUTPUT:
    #normal output
    {
      "version": 1,
      "creationDate": "",
      "modificationData": "",
      "ledgers": [
        {
          "ledgerId": 0,
          "entries": 0,
          "size": 0,
          "timestamp": 0
        }
      ],
      "terminatedPosition": {
        "ledgerId": 0,
        "entryId": 0
      },
      "cursors": {
        "hello": {
          "version": 0,
          "creationDate": "",
          "modificationDate": "",
          "cursorsLedgerId": 0,
          "markDelete": {
            "ledgerId": 0,
            "entryId": 0
          },
          "individualDeletedMessages": null,
          "Properties": null
        }
      }
    }


    #the topic name is not specified
    [✖]  only one argument is allowed to be used as a name

    #the specified topic does not existing
    [✖]  code: 500 reason: Unknown pulsar error

    #the topic name is not in the format of <tenant>/<namespace>/<topic> or <topic>
    [✖]  Invalid short topic name '<topic-name>', it should be in the format of <tenant>/<namespace>/<topic> or <topic>

    #the topic name is not in the format of <domain>://<tenant>/<namespace>/<topic>
    [✖]  Invalid complete topic name '<topic-name>', it should be in the format of <domain>://<tenant>/<namespace>/<topic>

    #the topic name is not in the format of <tenant>/<namespace>/<topic>
    [✖]  Invalid topic name '<topic-name>', it should be in the format of<tenant>/<namespace>/<topic>

    #the namespace name is not in the format of <tenant>/<namespace>
    [✖]  The complete name of namespace is invalid. complete name : <namespace-complete-name>

    #the tenant name and(or) namespace name is empty
    [✖]  Invalid tenant or namespace. [<tenant>/<namespace>]

    #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%)  is allowed
    [✖]  Tenant name include unsupported special chars. tenant : [<namespace>]

    #the namespace name contains unsupported special chars. the  alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed
    [✖]  Namespace name include unsupported special chars. namespace : [<namespace>]

Usage: pulsarctl topics internal-info [flags]
```
tisonkun pushed a commit to apache/pulsar-client-go that referenced this pull request Aug 16, 2023
### OUTPUT

*internal-info*
```
➜  pulsarctl git:(topic-info) ✗ ./pulsarctl topic internal-info -h
USED FOR:
    This command is used for getting the internal info of a topic which has messages or subscriptions.

REQUIRED PERMISSION:
    This command requires tenant admin permissions.

EXAMPLES:
    #Get the internal info of a topic <topic-name>
    pulsarctl topic internal-info <topic-name>

OUTPUT:
    #normal output
    {
      "version": 1,
      "creationDate": "",
      "modificationData": "",
      "ledgers": [
        {
          "ledgerId": 0,
          "entries": 0,
          "size": 0,
          "timestamp": 0
        }
      ],
      "terminatedPosition": {
        "ledgerId": 0,
        "entryId": 0
      },
      "cursors": {
        "hello": {
          "version": 0,
          "creationDate": "",
          "modificationDate": "",
          "cursorsLedgerId": 0,
          "markDelete": {
            "ledgerId": 0,
            "entryId": 0
          },
          "individualDeletedMessages": null,
          "Properties": null
        }
      }
    }


    #the topic name is not specified
    [✖]  only one argument is allowed to be used as a name

    #the specified topic does not existing
    [✖]  code: 500 reason: Unknown pulsar error

    #the topic name is not in the format of <tenant>/<namespace>/<topic> or <topic>
    [✖]  Invalid short topic name '<topic-name>', it should be in the format of <tenant>/<namespace>/<topic> or <topic>

    #the topic name is not in the format of <domain>://<tenant>/<namespace>/<topic>
    [✖]  Invalid complete topic name '<topic-name>', it should be in the format of <domain>://<tenant>/<namespace>/<topic>

    #the topic name is not in the format of <tenant>/<namespace>/<topic>
    [✖]  Invalid topic name '<topic-name>', it should be in the format of<tenant>/<namespace>/<topic>

    #the namespace name is not in the format of <tenant>/<namespace>
    [✖]  The complete name of namespace is invalid. complete name : <namespace-complete-name>

    #the tenant name and(or) namespace name is empty
    [✖]  Invalid tenant or namespace. [<tenant>/<namespace>]

    #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%)  is allowed
    [✖]  Tenant name include unsupported special chars. tenant : [<namespace>]

    #the namespace name contains unsupported special chars. the  alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed
    [✖]  Namespace name include unsupported special chars. namespace : [<namespace>]

Usage: pulsarctl topics internal-info [flags]
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants