INFO.d.ts 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. import { RedisCommandArgument } from '@redis/client/dist/lib/commands';
  2. export declare function transformArguments(index: string): Array<string>;
  3. type InfoRawReply = [
  4. 'index_name',
  5. RedisCommandArgument,
  6. 'index_options',
  7. Array<RedisCommandArgument>,
  8. 'index_definition',
  9. Array<RedisCommandArgument>,
  10. 'attributes',
  11. Array<Array<RedisCommandArgument>>,
  12. 'num_docs',
  13. RedisCommandArgument,
  14. 'max_doc_id',
  15. RedisCommandArgument,
  16. 'num_terms',
  17. RedisCommandArgument,
  18. 'num_records',
  19. RedisCommandArgument,
  20. 'inverted_sz_mb',
  21. RedisCommandArgument,
  22. 'vector_index_sz_mb',
  23. RedisCommandArgument,
  24. 'total_inverted_index_blocks',
  25. RedisCommandArgument,
  26. 'offset_vectors_sz_mb',
  27. RedisCommandArgument,
  28. 'doc_table_size_mb',
  29. RedisCommandArgument,
  30. 'sortable_values_size_mb',
  31. RedisCommandArgument,
  32. 'key_table_size_mb',
  33. RedisCommandArgument,
  34. 'records_per_doc_avg',
  35. RedisCommandArgument,
  36. 'bytes_per_record_avg',
  37. RedisCommandArgument,
  38. 'offsets_per_term_avg',
  39. RedisCommandArgument,
  40. 'offset_bits_per_record_avg',
  41. RedisCommandArgument,
  42. 'hash_indexing_failures',
  43. RedisCommandArgument,
  44. 'indexing',
  45. RedisCommandArgument,
  46. 'percent_indexed',
  47. RedisCommandArgument,
  48. 'gc_stats',
  49. [
  50. 'bytes_collected',
  51. RedisCommandArgument,
  52. 'total_ms_run',
  53. RedisCommandArgument,
  54. 'total_cycles',
  55. RedisCommandArgument,
  56. 'average_cycle_time_ms',
  57. RedisCommandArgument,
  58. 'last_run_time_ms',
  59. RedisCommandArgument,
  60. 'gc_numeric_trees_missed',
  61. RedisCommandArgument,
  62. 'gc_blocks_denied',
  63. RedisCommandArgument
  64. ],
  65. 'cursor_stats',
  66. [
  67. 'global_idle',
  68. number,
  69. 'global_total',
  70. number,
  71. 'index_capacity',
  72. number,
  73. 'index_total',
  74. number
  75. ],
  76. 'stopwords_list'?,
  77. Array<RedisCommandArgument>?
  78. ];
  79. interface InfoReply {
  80. indexName: RedisCommandArgument;
  81. indexOptions: Array<RedisCommandArgument>;
  82. indexDefinition: Record<string, RedisCommandArgument>;
  83. attributes: Array<Record<string, RedisCommandArgument>>;
  84. numDocs: RedisCommandArgument;
  85. maxDocId: RedisCommandArgument;
  86. numTerms: RedisCommandArgument;
  87. numRecords: RedisCommandArgument;
  88. invertedSzMb: RedisCommandArgument;
  89. vectorIndexSzMb: RedisCommandArgument;
  90. totalInvertedIndexBlocks: RedisCommandArgument;
  91. offsetVectorsSzMb: RedisCommandArgument;
  92. docTableSizeMb: RedisCommandArgument;
  93. sortableValuesSizeMb: RedisCommandArgument;
  94. keyTableSizeMb: RedisCommandArgument;
  95. recordsPerDocAvg: RedisCommandArgument;
  96. bytesPerRecordAvg: RedisCommandArgument;
  97. offsetsPerTermAvg: RedisCommandArgument;
  98. offsetBitsPerRecordAvg: RedisCommandArgument;
  99. hashIndexingFailures: RedisCommandArgument;
  100. indexing: RedisCommandArgument;
  101. percentIndexed: RedisCommandArgument;
  102. gcStats: {
  103. bytesCollected: RedisCommandArgument;
  104. totalMsRun: RedisCommandArgument;
  105. totalCycles: RedisCommandArgument;
  106. averageCycleTimeMs: RedisCommandArgument;
  107. lastRunTimeMs: RedisCommandArgument;
  108. gcNumericTreesMissed: RedisCommandArgument;
  109. gcBlocksDenied: RedisCommandArgument;
  110. };
  111. cursorStats: {
  112. globalIdle: number;
  113. globalTotal: number;
  114. indexCapacity: number;
  115. idnexTotal: number;
  116. };
  117. stopWords: Array<RedisCommandArgument> | undefined;
  118. }
  119. export declare function transformReply(rawReply: InfoRawReply): InfoReply;
  120. export {};