Skip to content

Commit

Permalink
fix: add proper exports
Browse files Browse the repository at this point in the history
  • Loading branch information
SkeLLLa committed Jul 16, 2024
1 parent 1d0c27d commit efc94ae
Show file tree
Hide file tree
Showing 91 changed files with 2,619 additions and 28 deletions.
39 changes: 39 additions & 0 deletions docs/api/pinot-noir.ebrokererrorcode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [EBrokerErrorCode](./pinot-noir.ebrokererrorcode.md)

## EBrokerErrorCode enum

**Signature:**

```typescript
export declare const enum EBrokerErrorCode
```

## Enumeration Members

<table><thead><tr><th>

Member

</th><th>

Value

</th><th>

Description

</th></tr></thead>
<tbody><tr><td>

UNKNOWN

</td><td>

`0`

</td><td>

</td></tr>
</tbody></table>
50 changes: 50 additions & 0 deletions docs/api/pinot-noir.ebrokertransporterrorcode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [EBrokerTransportErrorCode](./pinot-noir.ebrokertransporterrorcode.md)

## EBrokerTransportErrorCode enum

**Signature:**

```typescript
export declare const enum EBrokerTransportErrorCode
```

## Enumeration Members

<table><thead><tr><th>

Member

</th><th>

Value

</th><th>

Description

</th></tr></thead>
<tbody><tr><td>

INVALID_RESPONSE

</td><td>

`1`

</td><td>

</td></tr>
<tr><td>

UNKNOWN

</td><td>

`0`

</td><td>

</td></tr>
</tbody></table>
13 changes: 13 additions & 0 deletions docs/api/pinot-noir.ibrokerresponse.exceptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [IBrokerResponse](./pinot-noir.ibrokerresponse.md) &gt; [exceptions](./pinot-noir.ibrokerresponse.exceptions.md)

## IBrokerResponse.exceptions property

Will contain the stack trace if there is any exception processing the query.

**Signature:**

```typescript
exceptions?: IPinoException[];
```
233 changes: 233 additions & 0 deletions docs/api/pinot-noir.ibrokerresponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [IBrokerResponse](./pinot-noir.ibrokerresponse.md)

## IBrokerResponse interface

**Signature:**

```typescript
export interface IBrokerResponse
```

## Properties

<table><thead><tr><th>

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

</th></tr></thead>
<tbody><tr><td>

[exceptions?](./pinot-noir.ibrokerresponse.exceptions.md)

</td><td>

</td><td>

[IPinoException](./pinot-noir.ipinoexception.md)<!-- -->\[\]

</td><td>

_(Optional)_ Will contain the stack trace if there is any exception processing the query.

</td></tr>
<tr><td>

[minConsumingFreshnessTimeMs](./pinot-noir.ibrokerresponse.minconsumingfreshnesstimems.md)

</td><td>

</td><td>

number

</td><td>

</td></tr>
<tr><td>

[numConsumingSegmentsQueried](./pinot-noir.ibrokerresponse.numconsumingsegmentsqueried.md)

</td><td>

</td><td>

number

</td><td>

</td></tr>
<tr><td>

[numDocsScanned](./pinot-noir.ibrokerresponse.numdocsscanned.md)

</td><td>

</td><td>

number

</td><td>

</td></tr>
<tr><td>

[numEntriesScannedPostFilter](./pinot-noir.ibrokerresponse.numentriesscannedpostfilter.md)

</td><td>

</td><td>

number

</td><td>

The number of entries scanned after the filtering phase of query execution, ie. aggregation and/or group-by phases. This is equivalent to numDocScanned \* number of projected columns. This along with numEntriesScannedInFilter indicates where most of the time is spent during query processing. A high number for this means the selectivity is low (that is, Pinot needs to scan a lot of records to answer the query). If this is high, consider using star-tree index. (A regular inverted/bitmap index won't improve performance.)

</td></tr>
<tr><td>

[numGroupsLimitReached](./pinot-noir.ibrokerresponse.numgroupslimitreached.md)

</td><td>

</td><td>

boolean

</td><td>

If the query has a group by clause and top K, Pinot drops new entries after the numGroupsLimit is reached. If this boolean is set to true, the query result may not be accurate. The default value for numGroupsLimit is 100k, and should be sufficient for most use cases.

</td></tr>
<tr><td>

[numSegmentsMatched](./pinot-noir.ibrokerresponse.numsegmentsmatched.md)

</td><td>

</td><td>

number

</td><td>

</td></tr>
<tr><td>

[numSegmentsProcessed](./pinot-noir.ibrokerresponse.numsegmentsprocessed.md)

</td><td>

</td><td>

number

</td><td>

</td></tr>
<tr><td>

[numSegmentsQueried](./pinot-noir.ibrokerresponse.numsegmentsqueried.md)

</td><td>

</td><td>

number

</td><td>

</td></tr>
<tr><td>

[numServersQueries](./pinot-noir.ibrokerresponse.numserversqueries.md)

</td><td>

</td><td>

number

</td><td>

</td></tr>
<tr><td>

[numServersResponded](./pinot-noir.ibrokerresponse.numserversresponded.md)

</td><td>

</td><td>

number

</td><td>

</td></tr>
<tr><td>

[resultTable](./pinot-noir.ibrokerresponse.resulttable.md)

</td><td>

</td><td>

[IResultTable](./pinot-noir.iresulttable.md)

</td><td>

</td></tr>
<tr><td>

[timeUsedMs](./pinot-noir.ibrokerresponse.timeusedms.md)

</td><td>

</td><td>

number

</td><td>

</td></tr>
<tr><td>

[totalDocs](./pinot-noir.ibrokerresponse.totaldocs.md)

</td><td>

</td><td>

number

</td><td>

</td></tr>
<tr><td>

[traceInfo](./pinot-noir.ibrokerresponse.traceinfo.md)

</td><td>

</td><td>

Record&lt;string, string&gt;

</td><td>

</td></tr>
</tbody></table>
11 changes: 11 additions & 0 deletions docs/api/pinot-noir.ibrokerresponse.minconsumingfreshnesstimems.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [IBrokerResponse](./pinot-noir.ibrokerresponse.md) &gt; [minConsumingFreshnessTimeMs](./pinot-noir.ibrokerresponse.minconsumingfreshnesstimems.md)

## IBrokerResponse.minConsumingFreshnessTimeMs property

**Signature:**

```typescript
minConsumingFreshnessTimeMs: number;
```
11 changes: 11 additions & 0 deletions docs/api/pinot-noir.ibrokerresponse.numconsumingsegmentsqueried.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [IBrokerResponse](./pinot-noir.ibrokerresponse.md) &gt; [numConsumingSegmentsQueried](./pinot-noir.ibrokerresponse.numconsumingsegmentsqueried.md)

## IBrokerResponse.numConsumingSegmentsQueried property

**Signature:**

```typescript
numConsumingSegmentsQueried: number;
```
11 changes: 11 additions & 0 deletions docs/api/pinot-noir.ibrokerresponse.numdocsscanned.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [IBrokerResponse](./pinot-noir.ibrokerresponse.md) &gt; [numDocsScanned](./pinot-noir.ibrokerresponse.numdocsscanned.md)

## IBrokerResponse.numDocsScanned property

**Signature:**

```typescript
numDocsScanned: number;
```
13 changes: 13 additions & 0 deletions docs/api/pinot-noir.ibrokerresponse.numentriesscannedpostfilter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [IBrokerResponse](./pinot-noir.ibrokerresponse.md) &gt; [numEntriesScannedPostFilter](./pinot-noir.ibrokerresponse.numentriesscannedpostfilter.md)

## IBrokerResponse.numEntriesScannedPostFilter property

The number of entries scanned after the filtering phase of query execution, ie. aggregation and/or group-by phases. This is equivalent to numDocScanned \* number of projected columns. This along with numEntriesScannedInFilter indicates where most of the time is spent during query processing. A high number for this means the selectivity is low (that is, Pinot needs to scan a lot of records to answer the query). If this is high, consider using star-tree index. (A regular inverted/bitmap index won't improve performance.)

**Signature:**

```typescript
numEntriesScannedPostFilter: number;
```
Loading

0 comments on commit efc94ae

Please sign in to comment.